Manufacturing · Batch Manufacturing
Master Recipes
The process industry’s counterpart of a BOM plus a routing: its steps carry parameters with specifications, and its quantities scale with batch size.
/api/mfg/recipesPublished as /api/v1/recipesOverview
| 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 › Master Recipes 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.recipes · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/mfg/recipesList master recipes
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",
"recipe_no": "REC-000001",
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": "text",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard_batch_size": "1250.00",
"min_batch_size": "1250.00",
"max_batch_size": "1250.00",
"batch_uom": "text",
"expected_yield_pct": "1250.00",
"requires_batch_record": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/mfg/recipes?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/recipes/{id}Read one master recipe
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",
"recipe_no": "REC-000001",
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": "text",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard_batch_size": "1250.00",
"min_batch_size": "1250.00",
"max_batch_size": "1250.00",
"batch_uom": "text",
"expected_yield_pct": "1250.00",
"requires_batch_record": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/mfg/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/recipesCreate a master recipe
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
item_id | uuid | Yes | Item |
version | text | No | Version |
bom_id | uuid | No | Bill of material |
routing_id | uuid | No | Routing |
standard_batch_size | numeric | No | Standard batch size |
min_batch_size | numeric | No | Minimum batch |
max_batch_size | numeric | No | Maximum batch |
batch_uom | text | No | Batch unit |
expected_yield_pct | numeric | No | Expected yield % |
requires_batch_record | boolean | No | Produces a batch record |
requires_signature | boolean | No | Requires signatures |
gmp_class | text | No | GMP class |
change_order_id | uuid | No | Authorized by change order |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": "text",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard_batch_size": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_no": "REC-000001",
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": "text",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard_batch_size": "1250.00",
"min_batch_size": "1250.00",
"max_batch_size": "1250.00",
"batch_uom": "text",
"expected_yield_pct": "1250.00",
"requires_batch_record": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/mfg/recipes" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","version":"text","bom_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","routing_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","standard_batch_size":"1250.00"}'PUT/api/mfg/recipes/{id}Change a master recipe
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
name | text | Yes | Name |
item_id | uuid | Yes | Item |
version | text | No | Version |
bom_id | uuid | No | Bill of material |
routing_id | uuid | No | Routing |
standard_batch_size | numeric | No | Standard batch size |
min_batch_size | numeric | No | Minimum batch |
max_batch_size | numeric | No | Maximum batch |
batch_uom | text | No | Batch unit |
expected_yield_pct | numeric | No | Expected yield % |
requires_batch_record | boolean | No | Produces a batch record |
requires_signature | boolean | No | Requires signatures |
gmp_class | text | No | GMP class |
change_order_id | uuid | No | Authorized by change order |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
notes | text | No | Notes |
Sample body
{
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"recipe_no": "REC-000001",
"name": "Example",
"item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": "text",
"bom_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"routing_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"standard_batch_size": "1250.00",
"min_batch_size": "1250.00",
"max_batch_size": "1250.00",
"batch_uom": "text",
"expected_yield_pct": "1250.00",
"requires_batch_record": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/mfg/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Example","item_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/mfg/recipes/{id}Delete a master recipe
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/mfg/recipes/{parentId}/phasesPhases
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/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/phases" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/recipes/{parentId}/phasesPhases
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/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/phases" \
-H "Authorization: Bearer $TOKEN"PUT/api/mfg/recipes/{parentId}/phases/{lineId}Phases
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/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/mfg/recipes/{parentId}/phases/{lineId}Phases
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/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/phases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/mfg/recipes/{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/recipes/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/recipes/{id}/releaseRelease
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 POST "https://demo.tranxact.ai/api/mfg/recipes/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a master recipe, 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 |
recipe_no | text | read only | Recipe no |
name | text | read, write | Name |
item_id | uuid | read, write | Item |
version | text | read, write | Version |
bom_id | uuid | read, write | Bill of material |
routing_id | uuid | read, write | Routing |
standard_batch_size | numeric | read, write | Standard batch size |
min_batch_size | numeric | read, write | Minimum batch |
max_batch_size | numeric | read, write | Maximum batch |
batch_uom | text | read, write | Batch unit |
expected_yield_pct | numeric | read, write | Expected yield % |
requires_batch_record | boolean | read, write | Produces a batch record |
requires_signature | boolean | read, write | Requires signatures |
gmp_class | text | read, write | GMP class |
change_order_id | uuid | read, write | Authorized by change order |
effective_from | date | read, write | Effective from |
effective_to | date | read, write | Effective to |
status | text | read only | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
notes | text | read, write | 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 › Master Recipes 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.