TRANXACT.AI Help

Manufacturing · Quality Events

Customer Complaints

The regulated half of a complaint, which a service case cannot carry: the reportability decision, its clock, and whether the product actually failed.

Type REST11 operationsBase path /api/mfg/complaintsPublished as /api/v1/complaints

Download specification (OpenAPI 3.1) Screen: Customer Complaints

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 › Customer Complaints 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_complaints · 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

11 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/mfg/complaintsList customer complaints

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",
      "complaint_no": "COM-000001",
      "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "serial_no": "SER-000001",
      "quantity": "12.0000",
      "received_at": "2026-10-30T09:00:00Z",
      "description": "text",
      "complaint_category": "text",
      "severity": "critical",
      "is_reportable": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/mfg/complaints?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/complaints/{id}Read one complaint

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",
  "complaint_no": "COM-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity": "12.0000",
  "received_at": "2026-10-30T09:00:00Z",
  "description": "text",
  "complaint_category": "text",
  "severity": "critical",
  "is_reportable": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/mfg/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/complaintsCreate a complaint

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
case_iduuidNoService case — A complaint is already a case. This record adds only the regulated half.
customer_iduuidNoCustomer
item_iduuidNoItem
lot_notextNoLot
serial_notextNoSerial
quantitynumericNoQuantity
descriptiontextYesWhat the customer says
complaint_categorytextNoCategory
severitytextNoSeverity
Allowed: critical major minor cosmetic
is_reportablebooleanNoReportable to a regulator
reportability_decisiontextNoReportability reasoning
reportability_duedateNoReport by
regulatortextNoRegulator
report_referencetextNoReport reference
involves_injurybooleanNoInvolves an injury
investigation_outcometextNoInvestigation outcome
Allowed: confirmed_defect not_confirmed use_error expected_behavior transit_damage counterfeit inconclusive
nonconformance_iduuidNoNonconformance
capa_iduuidNoCAPA
returned_sample_receivedbooleanNoSample received

Sample body

{
  "description": "text",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "complaint_no": "COM-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity": "12.0000",
  "received_at": "2026-10-30T09:00:00Z",
  "description": "text",
  "complaint_category": "text",
  "severity": "critical",
  "is_reportable": true
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/complaints" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","case_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","customer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","lot_no":"LOT-000001"}'
PUT/api/mfg/complaints/{id}Change a complaint

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
case_iduuidNoService case — A complaint is already a case. This record adds only the regulated half.
customer_iduuidNoCustomer
item_iduuidNoItem
lot_notextNoLot
serial_notextNoSerial
quantitynumericNoQuantity
descriptiontextYesWhat the customer says
complaint_categorytextNoCategory
severitytextNoSeverity
Allowed: critical major minor cosmetic
is_reportablebooleanNoReportable to a regulator
reportability_decisiontextNoReportability reasoning
reportability_duedateNoReport by
regulatortextNoRegulator
report_referencetextNoReport reference
involves_injurybooleanNoInvolves an injury
investigation_outcometextNoInvestigation outcome
Allowed: confirmed_defect not_confirmed use_error expected_behavior transit_damage counterfeit inconclusive
nonconformance_iduuidNoNonconformance
capa_iduuidNoCAPA
returned_sample_receivedbooleanNoSample received

Sample body

{
  "description": "text",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "complaint_no": "COM-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity": "12.0000",
  "received_at": "2026-10-30T09:00:00Z",
  "description": "text",
  "complaint_category": "text",
  "severity": "critical",
  "is_reportable": true
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"description":"text","case_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/mfg/complaints/{id}Delete a complaint

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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/complaints/{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/complaints/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/complaints/{id}/investigateInvestigate

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/investigate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/complaints/{id}/await-sampleAwait sample

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/await-sample" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/complaints/{id}/respondRespond

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):

response, investigationOutcome

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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/respond" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"response":"value","investigationOutcome":"value"}'
POST/api/mfg/complaints/{id}/closeClose

Path parameters

NameTypeDescription
idstring (uuid)The record's id, 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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/complaints/{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/complaints/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'

Data model

Every field of a complaint, 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
complaint_notextread onlyComplaint no
case_iduuidread, writeService case — A complaint is already a case. This record adds only the regulated half.
customer_iduuidread, writeCustomer
item_iduuidread, writeItem
lot_notextread, writeLot
serial_notextread, writeSerial
quantitynumericread, writeQuantity
received_attimestamp with time zoneread onlyReceived at
descriptiontextread, writeWhat the customer says
complaint_categorytextread, writeCategory
severitytextread, writeSeverity
Allowed: critical major minor cosmetic
is_reportablebooleanread, writeReportable to a regulator
reportability_decisiontextread, writeReportability reasoning
reportability_decided_byuuidread onlyReportability decided by
reportability_duedateread, writeReport by
reported_attimestamp with time zoneread onlyReported at
regulatortextread, writeRegulator
report_referencetextread, writeReport reference
involves_injurybooleanread, writeInvolves an injury
investigation_outcometextread, writeInvestigation outcome
Allowed: confirmed_defect not_confirmed use_error expected_behavior transit_damage counterfeit inconclusive
nonconformance_iduuidread, writeNonconformance
capa_iduuidread, writeCAPA
returned_sample_receivedbooleanread, writeSample received
response_sent_attimestamp with time zoneread onlyResponse sent at
closed_attimestamp with time zoneread onlyClosed at
statustextread onlyStatus
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
investigation_started_attimestamp with time zoneread onlyInvestigation started at
response_texttextread onlyResponse text
closed_byuuidread onlyClosed by

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 › Customer Complaints 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.