Audit data model

Updated:

An internal, supplier, customer or certification audit

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstringNo
namestringNo
descriptionstringNo
typeenumNoValues: INTERNAL, SUPPLIER, CUSTOMER, CERTIFICATION, OTHER
original_typestringNoThe vendor's own audit type name
statusenumNoNormalized status of a quality record Values: OPEN, IN_PROGRESS, IN_REVIEW, CLOSED, CANCELLED
lifecycle_statestringNoVendor's own state or workflow step name
standardstringNoStandard audited against, e.g. AS9100D
scopestringNo
supplier_namestringNo
user_idstringNoLead auditor (reference to HrisEmployee)
scheduled_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
closed_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
issue_idsstring[]NoFindings, as QmsIssue IDs
file_idsstring[]NoAttachment IDs retrievable from StorageFile
urlstringNoDeep link to the vendor UI
metadataQmsMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field.
metadata[].valueobjectNoThe field's value, typed by format.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

TypeScript

TypeScript
export type QmsAudit = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	number?: string;
	name?: string;
	description?: string;
	type?: 'INTERNAL' | 'SUPPLIER' | 'CUSTOMER' | 'CERTIFICATION' | 'OTHER';
	original_type?: string; // The vendor's own audit type name
	status?: 'OPEN' | 'IN_PROGRESS' | 'IN_REVIEW' | 'CLOSED' | 'CANCELLED'; // Normalized status of a quality record
	lifecycle_state?: string; // Vendor's own state or workflow step name
	standard?: string; // Standard audited against, e.g. AS9100D
	scope?: string;
	supplier_name?: string;
	user_id?: string; // Lead auditor (reference to HrisEmployee)
	scheduled_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	closed_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	issue_ids?: string[]; // Findings, as QmsIssue IDs
	file_ids?: string[]; // Attachment IDs retrievable from StorageFile
	url?: string; // Deep link to the vendor UI
	metadata?: [];
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodQmsAudit = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	number: z.string().optional(),
	name: z.string().optional(),
	description: z.string().optional(),
	type: z.enum("INTERNAL", "SUPPLIER", "CUSTOMER", "CERTIFICATION", "OTHER").optional(),
	original_type: z.string().optional().describe("The vendor's own audit type name"),
	status: z.enum("OPEN", "IN_PROGRESS", "IN_REVIEW", "CLOSED", "CANCELLED").optional().describe("Normalized status of a quality record"),
	lifecycle_state: z.string().optional().describe("Vendor's own state or workflow step name"),
	standard: z.string().optional().describe("Standard audited against, e.g. AS9100D"),
	scope: z.string().optional(),
	supplier_name: z.string().optional(),
	user_id: z.string().optional().describe("Lead auditor (reference to HrisEmployee)"),
	scheduled_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	closed_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	issue_ids: z.array().optional().describe("Findings, as QmsIssue IDs"),
	file_ids: z.array().optional().describe("Attachment IDs retrievable from StorageFile"),
	url: z.string().optional().describe("Deep link to the vendor UI"),
	metadata: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class QmsAuditType(str, Enum):
	INTERNAL = 'INTERNAL'
	SUPPLIER = 'SUPPLIER'
	CUSTOMER = 'CUSTOMER'
	CERTIFICATION = 'CERTIFICATION'
	OTHER = 'OTHER'

@dataclasses.dataclass
class QmsAuditStatus(str, Enum):
	OPEN = 'OPEN'
	IN_PROGRESS = 'IN_PROGRESS'
	IN_REVIEW = 'IN_REVIEW'
	CLOSED = 'CLOSED'
	CANCELLED = 'CANCELLED'

@dataclasses.dataclass
class QmsAudit:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	number: Optional[str]
	name: Optional[str]
	description: Optional[str]
	type: Optional[QmsAuditType]
	"""The vendor's own audit type name"""
	original_type: Optional[str]
	"""Normalized status of a quality record"""
	status: Optional[QmsAuditStatus]
	"""Vendor's own state or workflow step name"""
	lifecycle_state: Optional[str]
	"""Standard audited against, e.g. AS9100D"""
	standard: Optional[str]
	scope: Optional[str]
	supplier_name: Optional[str]
	"""Lead auditor (reference to HrisEmployee)"""
	user_id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	scheduled_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	closed_at: Optional[str]
	"""Findings, as QmsIssue IDs"""
	issue_ids: Optional[List[List[str]]]
	"""Attachment IDs retrievable from StorageFile"""
	file_ids: Optional[List[List[str]]]
	"""Deep link to the vendor UI"""
	url: Optional[str]
	metadata: Optional[PropertyQmsAuditMetadata]
Are we missing anything? Let us know
Was this page helpful?