TRANXACT.AI Help

Manufacturing · Batch Manufacturing

Batch Records

What a batch DID, in the order it happened, with every controlled parameter against the specification it was supposed to meet. Review by exception: the counts say whether it can be released without reading two hundred pages.

Type REST14 operationsBase path /api/mfg/batch-recordsPublished as /api/v1/batch-records

Download specification (OpenAPI 3.1) Screen: Batch Records

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 › Batch Records 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.batch_records · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

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

GET/api/mfg/batch-recordsList batch records

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",
      "batch_no": "BAT-000001",
      "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "recipe_version": "text",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "lot_no": "LOT-000001",
      "batch_size": "1250.00",
      "qty_produced": "12.0000",
      "qty_rejected": "12.0000",
      "actual_yield_pct": "1250.00",
      "started_at": "2026-10-30T09:00:00Z",
      "completed_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "batch_no": "BAT-000001",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recipe_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "recipe_version": "text",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "lot_no": "LOT-000001",
  "batch_size": "1250.00",
  "qty_produced": "12.0000",
  "qty_rejected": "12.0000",
  "actual_yield_pct": "1250.00",
  "started_at": "2026-10-30T09:00:00Z",
  "completed_at": "2026-10-30T09:00:00Z"
}

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

Sample request

curl "https://demo.tranxact.ai/api/mfg/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/mfg/batch-records/{parentId}/stepsSteps

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

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/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/mfg/batch-records/{parentId}/steps/{lineId}Steps

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/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/batch-records/{parentId}/steps/{lineId}Steps

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/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/steps/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/batch-recordsPost batch records

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

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 PUT "https://demo.tranxact.ai/api/mfg/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/batch-records/{id}Delete batch records

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 DELETE "https://demo.tranxact.ai/api/mfg/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/batch-records/createCreate

Request body

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

productionOrderId, recipeId, lotNo, batchSize

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/batch-records/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"productionOrderId":"value","recipeId":"value","lotNo":"value","batchSize":"value"}'
POST/api/mfg/batch-records/{id}/signSign

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

meaning, batchStepId, deviationId, role, authMethod, comment; meaning one of performed|verified|reviewed|approved|released|rejected|witnessed; authMethod one of password|sso|pin|badge|biometric

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/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"meaning":"value","batchStepId":"value","deviationId":"value","role":"value","authMethod":"value","comment;":"value"}'
GET/api/mfg/batch-records/{id}/reviewReview

Path parameters

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

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/mfg/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/review" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/batch-records/{id}/releaseRelease

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

qtyProduced, qtyRejected, authMethod; authMethod one of password|sso|pin|badge|biometric

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/batch-records/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"qtyProduced":"value","qtyRejected":"value","authMethod;":"value"}'

Data model

Every field of a batch record, 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
batch_notextread onlyBatch no
production_order_iduuidread onlyProduction order id
recipe_iduuidread onlyRecipe id
recipe_versiontextread onlyRecipe version
item_iduuidread onlyItem id
lot_notextread onlyLot no
batch_sizenumericread onlyBatch size
qty_producednumericread onlyQty produced
qty_rejectednumericread onlyQty rejected
actual_yield_pctnumericread onlyActual yield pct
started_attimestamp with time zoneread onlyStarted at
completed_attimestamp with time zoneread onlyCompleted at
expiry_datedateread onlyExpiry date
deviation_countintegerread onlyDeviation count
out_of_spec_countintegerread onlyOut of spec count
open_step_countintegerread onlyOpen step count
unsigned_step_countintegerread onlyUnsigned step count
review_verdicttextread onlyReview verdict
reviewed_byuuidread onlyReviewed by
reviewed_attimestamp with time zoneread onlyReviewed at
released_byuuidread onlyReleased by
released_attimestamp with time zoneread onlyReleased at
statustextread onlyStatus
notestextread onlyNotes
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 › Batch Records 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.