TRANXACT.AI Help

Manufacturing · Quality Events

Nonconformances

Something is wrong with identified material. Containment before analysis: what is affected, where it is, and whether any of it has already gone to a customer.

Type REST8 operationsBase path /api/mfg/nonconformancesPublished as /api/v1/nonconformances

Download specification (OpenAPI 3.1) Screen: Nonconformances

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 › Nonconformances 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.nonconformances · 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

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

GET/api/mfg/nonconformancesList nonconformances

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",
      "ncr_no": "NCR-000001",
      "title": "Example",
      "description": "text",
      "found_at_stage": "incoming",
      "source": "internal",
      "severity": "critical",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "serial_no": "SER-000001",
      "quantity_affected": "12.0000",
      "quantity_inspected": "12.0000",
      "uom": "text"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "ncr_no": "NCR-000001",
  "title": "Example",
  "description": "text",
  "found_at_stage": "incoming",
  "source": "internal",
  "severity": "critical",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity_affected": "12.0000",
  "quantity_inspected": "12.0000",
  "uom": "text"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
titletextYesWhat is wrong
descriptiontextNoDescription
found_at_stagetextNoFound at
Allowed: incoming in_process final pre_ship customer field audit storage
sourcetextNoSource
Allowed: internal supplier customer regulatory audit
severitytextNoSeverity
Allowed: critical major minor cosmetic
item_iduuidNoItem
lot_notextNoLot
serial_notextNoSerial
quantity_affectednumericNoQuantity affected
quantity_inspectednumericNoQuantity inspected
uomtextNoUnit
production_order_iduuidNoProduction order
inspection_iduuidNoInspection id
batch_record_iduuidNoBatch record id
batch_deviation_iduuidNoBatch deviation id
receipt_iduuidNoReceipt id
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
work_center_iduuidNoWork center
equipment_iduuidNoMachine
defect_code_iduuidNoDefect
cost_materialnumericNoMaterial cost
cost_labornumericNoLabor cost
cost_totalnumericNoTotal cost
currencytextNoCurrency
supplier_chargebacknumericNoChargeback to supplier

Sample body

{
  "title": "Example",
  "description": "text",
  "found_at_stage": "incoming",
  "source": "internal",
  "severity": "critical"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ncr_no": "NCR-000001",
  "title": "Example",
  "description": "text",
  "found_at_stage": "incoming",
  "source": "internal",
  "severity": "critical",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity_affected": "12.0000",
  "quantity_inspected": "12.0000",
  "uom": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/nonconformances" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","description":"text","found_at_stage":"incoming","source":"internal","severity":"critical"}'
PUT/api/mfg/nonconformances/{id}Change a nonconformance

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
titletextYesWhat is wrong
descriptiontextNoDescription
found_at_stagetextNoFound at
Allowed: incoming in_process final pre_ship customer field audit storage
sourcetextNoSource
Allowed: internal supplier customer regulatory audit
severitytextNoSeverity
Allowed: critical major minor cosmetic
item_iduuidNoItem
lot_notextNoLot
serial_notextNoSerial
quantity_affectednumericNoQuantity affected
quantity_inspectednumericNoQuantity inspected
uomtextNoUnit
production_order_iduuidNoProduction order
inspection_iduuidNoInspection id
batch_record_iduuidNoBatch record id
batch_deviation_iduuidNoBatch deviation id
receipt_iduuidNoReceipt id
supplier_iduuidNoSupplier
customer_iduuidNoCustomer
work_center_iduuidNoWork center
equipment_iduuidNoMachine
defect_code_iduuidNoDefect
cost_materialnumericNoMaterial cost
cost_labornumericNoLabor cost
cost_totalnumericNoTotal cost
currencytextNoCurrency
supplier_chargebacknumericNoChargeback to supplier

Sample body

{
  "title": "Example",
  "description": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ncr_no": "NCR-000001",
  "title": "Example",
  "description": "text",
  "found_at_stage": "incoming",
  "source": "internal",
  "severity": "critical",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "serial_no": "SER-000001",
  "quantity_affected": "12.0000",
  "quantity_inspected": "12.0000",
  "uom": "text"
}

Sample request

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

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

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

action*, recallRequired, quantityQuarantined, quarantineBinId

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/nonconformances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/contain" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"value","recallRequired":"value","quantityQuarantined":"value","quarantineBinId":"value"}'
POST/api/mfg/nonconformances/{id}/dispositionDisposition

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

disposition, justification*, raiseCapa; disposition one of use_as_is|rework|regrade|repair|scrap|return_to_supplier

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/nonconformances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disposition" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"disposition":"value","justification":"value","raiseCapa;":"value"}'

Data model

Every field of a nonconformance, 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
ncr_notextread onlyNcr no
titletextread, writeWhat is wrong
descriptiontextread, writeDescription
found_at_stagetextread, writeFound at
Allowed: incoming in_process final pre_ship customer field audit storage
sourcetextread, writeSource
Allowed: internal supplier customer regulatory audit
severitytextread, writeSeverity
Allowed: critical major minor cosmetic
item_iduuidread, writeItem
lot_notextread, writeLot
serial_notextread, writeSerial
quantity_affectednumericread, writeQuantity affected
quantity_inspectednumericread, writeQuantity inspected
uomtextread, writeUnit
production_order_iduuidread, writeProduction order
inspection_iduuidread, writeInspection id
batch_record_iduuidread, writeBatch record id
batch_deviation_iduuidread, writeBatch deviation id
receipt_iduuidread, writeReceipt id
supplier_iduuidread, writeSupplier
customer_iduuidread, writeCustomer
work_center_iduuidread, writeWork center
equipment_iduuidread, writeMachine
defect_code_iduuidread, writeDefect
containment_actiontextread onlyContainment action
contained_attimestamp with time zoneread onlyContained at
quantity_quarantinednumericread onlyQuantity quarantined
quarantine_bin_iduuidread onlyQuarantine bin id
shipped_quantitynumericread onlyShipped quantity
customer_notifiedbooleanread onlyCustomer notified
recall_requiredbooleanread onlyRecall required
dispositiontextread onlyDisposition
disposition_byuuidread onlyDisposition by
disposition_attimestamp with time zoneread onlyDisposition at
disposition_justificationtextread onlyDisposition justification
rework_order_iduuidread onlyRework order id
cost_materialnumericread, writeMaterial cost
cost_labornumericread, writeLabor cost
cost_totalnumericread, writeTotal cost
currencytextread, writeCurrency
journal_iduuidread onlyJournal id
supplier_chargebacknumericread, writeChargeback to supplier
capa_iduuidread onlyCapa id
raised_byuuidread onlyRaised by
raised_attimestamp with time zoneread onlyRaised at
closed_byuuidread onlyClosed by
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

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 › Nonconformances 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.