Manufacturing · Quality Events
Audits
Internal, supplier, customer and certification audits, with the finding counts that say whether it was a good audit or a quiet one.
/api/mfg/quality-auditsPublished as /api/v1/quality-auditsOverview
| Package | Manufacturing |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Manufacturing › Audits on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | mfg.quality_audits · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
15 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/quality-auditsList audits
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"audit_no": "AUD-000001",
"title": "Example",
"audit_type": "internal",
"standard": "text",
"scope": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"lead_auditor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auditor_names": "Example",
"planned_from": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/quality-audits?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/quality-audits/{id}Read one audit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"audit_no": "AUD-000001",
"title": "Example",
"audit_type": "internal",
"standard": "text",
"scope": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"lead_auditor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auditor_names": "Example",
"planned_from": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/quality-auditsCreate a audit
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
audit_type | text | No | Type Allowed: internal supplier customer certification regulatory process product layered |
standard | text | No | Standard — ISO 9001, IATF 16949, ISO 13485… |
scope | text | No | Scope |
supplier_id | uuid | No | Supplier |
customer_id | uuid | No | Customer |
location_id | uuid | No | Location |
process_area | text | No | Process area |
lead_auditor_id | uuid | No | Lead auditor |
auditor_names | text | No | Other auditors |
planned_from | date | No | Planned from |
planned_to | date | No | Planned to |
performed_from | date | No | Performed from |
performed_to | date | No | Performed to |
result | text | No | Result Allowed: pass pass_with_findings conditional fail not_completed |
score_pct | numeric | No | Score % |
report_content_id | uuid | No | Report content id |
next_audit_due | date | No | Next audit due |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"audit_type": "internal",
"standard": "text",
"scope": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"audit_no": "AUD-000001",
"title": "Example",
"audit_type": "internal",
"standard": "text",
"scope": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"lead_auditor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auditor_names": "Example",
"planned_from": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","audit_type":"internal","standard":"text","scope":"text","supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/mfg/quality-audits/{id}Change a audit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
title | text | Yes | Title |
audit_type | text | No | Type Allowed: internal supplier customer certification regulatory process product layered |
standard | text | No | Standard — ISO 9001, IATF 16949, ISO 13485… |
scope | text | No | Scope |
supplier_id | uuid | No | Supplier |
customer_id | uuid | No | Customer |
location_id | uuid | No | Location |
process_area | text | No | Process area |
lead_auditor_id | uuid | No | Lead auditor |
auditor_names | text | No | Other auditors |
planned_from | date | No | Planned from |
planned_to | date | No | Planned to |
performed_from | date | No | Performed from |
performed_to | date | No | Performed to |
result | text | No | Result Allowed: pass pass_with_findings conditional fail not_completed |
score_pct | numeric | No | Score % |
report_content_id | uuid | No | Report content id |
next_audit_due | date | No | Next audit due |
notes | text | No | Notes |
Sample body
{
"title": "Example",
"audit_type": "internal"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"audit_no": "AUD-000001",
"title": "Example",
"audit_type": "internal",
"standard": "text",
"scope": "text",
"supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"process_area": "text",
"lead_auditor_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auditor_names": "Example",
"planned_from": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"title":"Example","audit_type":"internal"}'DELETE/api/mfg/quality-audits/{id}Delete a audit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/quality-audits/{parentId}/findingsFindings
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/findings" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/quality-audits/{parentId}/findingsFindings
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/findings" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/quality-audits/{parentId}/findings/{lineId}Findings
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/findings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/quality-audits/{parentId}/findings/{lineId}Findings
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/findings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/quality-audits/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'POST/api/mfg/quality-audits/{id}/scheduleSchedule
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
plannedFrom, plannedToResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/schedule" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"plannedFrom":"value","plannedTo":"value"}'POST/api/mfg/quality-audits/{id}/startStart
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
performedFromResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"performedFrom":"value"}'POST/api/mfg/quality-audits/{id}/reportReport
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
performedTo, result, scorePctResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/report" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"performedTo":"value","result":"value","scorePct":"value"}'POST/api/mfg/quality-audits/{id}/closeClose
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
resultResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"result":"value"}'POST/api/mfg/quality-audits/{id}/cancelCancel
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
reasonResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/quality-audits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'Data model
Every field of a audit, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
audit_no | text | read only | Audit no |
title | text | read, write | Title |
audit_type | text | read, write | Type Allowed: internal supplier customer certification regulatory process product layered |
standard | text | read, write | Standard — ISO 9001, IATF 16949, ISO 13485… |
scope | text | read, write | Scope |
supplier_id | uuid | read, write | Supplier |
customer_id | uuid | read, write | Customer |
location_id | uuid | read, write | Location |
process_area | text | read, write | Process area |
lead_auditor_id | uuid | read, write | Lead auditor |
auditor_names | text | read, write | Other auditors |
planned_from | date | read, write | Planned from |
planned_to | date | read, write | Planned to |
performed_from | date | read, write | Performed from |
performed_to | date | read, write | Performed to |
result | text | read, write | Result Allowed: pass pass_with_findings conditional fail not_completed |
major_findings | integer | read only | Major findings |
minor_findings | integer | read only | Minor findings |
observations | integer | read only | Observations |
score_pct | numeric | read, write | Score % |
report_content_id | uuid | read, write | Report content id |
next_audit_due | date | read, write | Next audit due |
status | text | read only | Status |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
closed_at | timestamp with time zone | read only | Closed at |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Manufacturing › Audits for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.