TRANXACT.AI Help

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.

Type REST15 operationsBase path /api/mfg/quality-auditsPublished as /api/v1/quality-audits

Download specification (OpenAPI 3.1) Screen: Audits

Overview

PackageManufacturing
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablemfg.quality_audits · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
titletextYesTitle
audit_typetextNoType
Allowed: internal supplier customer certification regulatory process product layered
standardtextNoStandard — ISO 9001, IATF 16949, ISO 13485…
scopetextNoScope
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
location_iduuidNoLocation
process_areatextNoProcess area
lead_auditor_iduuidNoLead auditor
auditor_namestextNoOther auditors
planned_fromdateNoPlanned from
planned_todateNoPlanned to
performed_fromdateNoPerformed from
performed_todateNoPerformed to
resulttextNoResult
Allowed: pass pass_with_findings conditional fail not_completed
score_pctnumericNoScore %
report_content_iduuidNoReport content id
next_audit_duedateNoNext audit due
notestextNoNotes

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
titletextYesTitle
audit_typetextNoType
Allowed: internal supplier customer certification regulatory process product layered
standardtextNoStandard — ISO 9001, IATF 16949, ISO 13485…
scopetextNoScope
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
location_iduuidNoLocation
process_areatextNoProcess area
lead_auditor_iduuidNoLead auditor
auditor_namestextNoOther auditors
planned_fromdateNoPlanned from
planned_todateNoPlanned to
performed_fromdateNoPerformed from
performed_todateNoPerformed to
resulttextNoResult
Allowed: pass pass_with_findings conditional fail not_completed
score_pctnumericNoScore %
report_content_iduuidNoReport content id
next_audit_duedateNoNext audit due
notestextNoNotes

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

NameTypeDescription
idstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (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

NameTypeDescription
idstring (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, withLines

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/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

NameTypeDescription
idstring (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, plannedTo

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/schedule" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"plannedFrom":"value","plannedTo":"value"}'
POST/api/mfg/quality-audits/{id}/startStart

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

performedFrom

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/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"performedFrom":"value"}'
POST/api/mfg/quality-audits/{id}/reportReport

Path parameters

NameTypeDescription
idstring (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, scorePct

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/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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

result

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/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"result":"value"}'
POST/api/mfg/quality-audits/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
audit_notextread onlyAudit no
titletextread, writeTitle
audit_typetextread, writeType
Allowed: internal supplier customer certification regulatory process product layered
standardtextread, writeStandard — ISO 9001, IATF 16949, ISO 13485…
scopetextread, writeScope
supplier_iduuidread, writeSupplier
customer_iduuidread, writeCustomer
location_iduuidread, writeLocation
process_areatextread, writeProcess area
lead_auditor_iduuidread, writeLead auditor
auditor_namestextread, writeOther auditors
planned_fromdateread, writePlanned from
planned_todateread, writePlanned to
performed_fromdateread, writePerformed from
performed_todateread, writePerformed to
resulttextread, writeResult
Allowed: pass pass_with_findings conditional fail not_completed
major_findingsintegerread onlyMajor findings
minor_findingsintegerread onlyMinor findings
observationsintegerread onlyObservations
score_pctnumericread, writeScore %
report_content_iduuidread, writeReport content id
next_audit_duedateread, writeNext audit due
statustextread onlyStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
closed_attimestamp with time zoneread onlyClosed at

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Manufacturing › Audits for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.