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.
/api/mfg/batch-recordsPublished as /api/v1/batch-recordsOverview
| Package | Manufacturing |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The 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. |
| Table | mfg.batch_records · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The 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
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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, batchSizeResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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|biometricResponse
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
| Name | Type | Description |
|---|---|---|
id | string (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
| Name | Type | Description |
|---|---|---|
id | string (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|biometricResponse
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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
batch_no | text | read only | Batch no |
production_order_id | uuid | read only | Production order id |
recipe_id | uuid | read only | Recipe id |
recipe_version | text | read only | Recipe version |
item_id | uuid | read only | Item id |
lot_no | text | read only | Lot no |
batch_size | numeric | read only | Batch size |
qty_produced | numeric | read only | Qty produced |
qty_rejected | numeric | read only | Qty rejected |
actual_yield_pct | numeric | read only | Actual yield pct |
started_at | timestamp with time zone | read only | Started at |
completed_at | timestamp with time zone | read only | Completed at |
expiry_date | date | read only | Expiry date |
deviation_count | integer | read only | Deviation count |
out_of_spec_count | integer | read only | Out of spec count |
open_step_count | integer | read only | Open step count |
unsigned_step_count | integer | read only | Unsigned step count |
review_verdict | text | read only | Review verdict |
reviewed_by | uuid | read only | Reviewed by |
reviewed_at | timestamp with time zone | read only | Reviewed at |
released_by | uuid | read only | Released by |
released_at | timestamp with time zone | read only | Released at |
status | text | read only | Status |
notes | text | read only | Notes |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Manufacturing › Batch Records for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.