TRANXACT.AI Help

Manufacturing · Inspection & Disposition

Usage Decisions

What was decided about each inspection lot: accepted, returned, reworked, scrapped, replaced, or accepted with an approved deviation — with the reason, the corrective action, what it raised and what it did to the stock held for the lot. A lot that passes is accepted by the system unless the company decides every lot itself.

Type REST6 operationsBase path /api/mfg/usage-decisionsPublished as /api/v1/usage-decisions

Download specification (OpenAPI 3.1) Screen: Usage Decisions

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 › Usage Decisions 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.usage_decisions · 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

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

GET/api/mfg/usage-decisionsList usage decisions

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",
      "decision_no": "DEC-000001",
      "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "decision": "text",
      "quantity": "12.0000",
      "reason": "text",
      "comments": "text",
      "corrective_action": "text",
      "vendor_action": "text",
      "requires_reinspection": true,
      "reinspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "rework_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "decision_no": "DEC-000001",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision": "text",
  "quantity": "12.0000",
  "reason": "text",
  "comments": "text",
  "corrective_action": "text",
  "vendor_action": "text",
  "requires_reinspection": true,
  "reinspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rework_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
decision_notextYesDecision no
inspection_iduuidYesInspection
decisiontextYesDisposition
quantitynumericNoQuantity
reasontextYesWhy — The record somebody relies on when the same defect turns up again.
commentstextNoComments
corrective_actiontextNoCorrective action
vendor_actiontextNoVendor action
requires_reinspectionbooleanNoRe-inspect after the work
return_to_op_nointegerNoReturn to operation
alternate_item_iduuidNoAlternative material
deviation_approved_byuuidNoDeviation approved by — Required when accepting material that failed. Somebody has to own that.

Sample body

{
  "decision_no": "DEC-000001",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision": "text",
  "reason": "text",
  "quantity": "12.0000",
  "comments": "text",
  "corrective_action": "text",
  "vendor_action": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision_no": "DEC-000001",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision": "text",
  "quantity": "12.0000",
  "reason": "text",
  "comments": "text",
  "corrective_action": "text",
  "vendor_action": "text",
  "requires_reinspection": true,
  "reinspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rework_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/usage-decisions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision_no":"DEC-000001","inspection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","decision":"text","reason":"text","quantity":"12.0000","comments":"text","corrective_action":"text","vendor_action":"text"}'
PUT/api/mfg/usage-decisions/{id}Change a usage decision

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
decision_notextYesDecision no
inspection_iduuidYesInspection
decisiontextYesDisposition
quantitynumericNoQuantity
reasontextYesWhy — The record somebody relies on when the same defect turns up again.
commentstextNoComments
corrective_actiontextNoCorrective action
vendor_actiontextNoVendor action
requires_reinspectionbooleanNoRe-inspect after the work
return_to_op_nointegerNoReturn to operation
alternate_item_iduuidNoAlternative material
deviation_approved_byuuidNoDeviation approved by — Required when accepting material that failed. Somebody has to own that.

Sample body

{
  "decision_no": "DEC-000001",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision_no": "DEC-000001",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "decision": "text",
  "quantity": "12.0000",
  "reason": "text",
  "comments": "text",
  "corrective_action": "text",
  "vendor_action": "text",
  "requires_reinspection": true,
  "reinspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "requisition_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "rework_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/usage-decisions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision_no":"DEC-000001","inspection_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/mfg/usage-decisions/{id}Delete a usage decision

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/usage-decisions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/usage-decisions/{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/usage-decisions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a usage decision, 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
decision_notextread, writeDecision no
inspection_iduuidread, writeInspection
decisiontextread, writeDisposition
quantitynumericread, writeQuantity
reasontextread, writeWhy — The record somebody relies on when the same defect turns up again.
commentstextread, writeComments
corrective_actiontextread, writeCorrective action
vendor_actiontextread, writeVendor action
requires_reinspectionbooleanread, writeRe-inspect after the work
reinspection_iduuidread onlyReinspection id
requisition_iduuidread onlyRequisition id
rework_order_iduuidread onlyRework order id
nonconformance_iduuidread onlyNonconformance id
return_to_op_nointegerread, writeReturn to operation
alternate_item_iduuidread, writeAlternative material
deviation_approved_byuuidread, writeDeviation approved by — Required when accepting material that failed. Somebody has to own that.
decided_byuuidread onlyDecided by
decided_attimestamp with time zoneread onlyDecided at
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 › Usage Decisions 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.