TRANXACT.AI Help

Manufacturing · Manufacturing Intelligence

Document Intelligence

Certificates, mill reports and packing lists read into fields — and, the part that matters, CHECKED against the item’s specification. A certificate transcribed perfectly and compared with nothing has saved typing and nothing else.

Type REST7 operationsBase path /api/mfg/document-extractionsPublished as /api/v1/document-extractions

Download specification (OpenAPI 3.1) Screen: Document Intelligence

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 › Document Intelligence 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.document_extractions · 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

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

GET/api/mfg/document-extractionsList document intelligence

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",
      "extraction_no": "EXT-000001",
      "document_kind": "certificate_of_analysis",
      "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "file_name": "Example",
      "page_count": 10,
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "extraction_no": "EXT-000001",
  "document_kind": "certificate_of_analysis",
  "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "page_count": 10,
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_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/document-extractions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/document-extractionsCreate a document extraction

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
document_kindtextYesKind
Allowed: certificate_of_analysis certificate_of_conformance mill_test_report packing_list supplier_drawing customer_specification inspection_report calibration_certificate safety_data_sheet work_instruction purchase_order other
content_iduuidNoContent id
file_nametextNoFile name
page_countintegerNoPages
supplier_iduuidNoSupplier
customer_iduuidNoCustomer id
item_iduuidNoItem
lot_notextNoLot
receipt_iduuidNoGoods receipt
purchase_order_iduuidNoPurchase order id
inspection_iduuidNoInspection id
gauge_iduuidNoGauge, for a calibration certificate
extractedjsonbNoExtracted fields

Sample body

{
  "document_kind": "certificate_of_analysis",
  "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "page_count": 10,
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "extraction_no": "EXT-000001",
  "document_kind": "certificate_of_analysis",
  "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "page_count": 10,
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/document-extractions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"document_kind":"certificate_of_analysis","content_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","file_name":"Example","page_count":10,"supplier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/document-extractions/{id}Change a document extraction

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
document_kindtextYesKind
Allowed: certificate_of_analysis certificate_of_conformance mill_test_report packing_list supplier_drawing customer_specification inspection_report calibration_certificate safety_data_sheet work_instruction purchase_order other
content_iduuidNoContent id
file_nametextNoFile name
page_countintegerNoPages
supplier_iduuidNoSupplier
customer_iduuidNoCustomer id
item_iduuidNoItem
lot_notextNoLot
receipt_iduuidNoGoods receipt
purchase_order_iduuidNoPurchase order id
inspection_iduuidNoInspection id
gauge_iduuidNoGauge, for a calibration certificate
extractedjsonbNoExtracted fields

Sample body

{
  "document_kind": "certificate_of_analysis",
  "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "extraction_no": "EXT-000001",
  "document_kind": "certificate_of_analysis",
  "content_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "file_name": "Example",
  "page_count": 10,
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "customer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "receipt_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "purchase_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "inspection_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/document-extractions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"document_kind":"certificate_of_analysis","content_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/mfg/document-extractions/{id}Delete a document extraction

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

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/document-extractions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/check-spec" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a document extraction, 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
extraction_notextread onlyExtraction no
document_kindtextread, writeKind
Allowed: certificate_of_analysis certificate_of_conformance mill_test_report packing_list supplier_drawing customer_specification inspection_report calibration_certificate safety_data_sheet work_instruction purchase_order other
content_iduuidread, writeContent id
file_nametextread, writeFile name
page_countintegerread, writePages
supplier_iduuidread, writeSupplier
customer_iduuidread, writeCustomer id
item_iduuidread, writeItem
lot_notextread, writeLot
receipt_iduuidread, writeGoods receipt
purchase_order_iduuidread, writePurchase order id
inspection_iduuidread, writeInspection id
gauge_iduuidread, writeGauge, for a calibration certificate
extractedjsonbread, writeExtracted fields
field_countintegerread onlyField count
low_confidence_countintegerread onlyLow confidence count
overall_confidencenumericread onlyOverall confidence
spec_checkedbooleanread onlySpec checked
spec_resulttextread onlySpec result
spec_failuresjsonbread onlySpec failures
reviewed_byuuidread onlyReviewed by
reviewed_attimestamp with time zoneread onlyReviewed at
correctionsjsonbread onlyCorrections
posted_totextread onlyPosted to
statustextread onlyStatus
error_texttextread onlyError text
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 › Document Intelligence 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.