TRANXACT.AI Help

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.

Type REST11 operationsBase path /api/mfg/recipesPublished as /api/v1/recipes

Download specification (OpenAPI 3.1) Screen: Master Recipes

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 › 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.
Tablemfg.recipes · 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

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

GET/api/mfg/recipesList master recipes

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
nametextYesName
item_iduuidYesItem
versiontextNoVersion
bom_iduuidNoBill of material
routing_iduuidNoRouting
standard_batch_sizenumericNoStandard batch size
min_batch_sizenumericNoMinimum batch
max_batch_sizenumericNoMaximum batch
batch_uomtextNoBatch unit
expected_yield_pctnumericNoExpected yield %
requires_batch_recordbooleanNoProduces a batch record
requires_signaturebooleanNoRequires signatures
gmp_classtextNoGMP class
change_order_iduuidNoAuthorized by change order
effective_fromdateNoEffective from
effective_todateNoEffective to
notestextNoNotes

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

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
nametextYesName
item_iduuidYesItem
versiontextNoVersion
bom_iduuidNoBill of material
routing_iduuidNoRouting
standard_batch_sizenumericNoStandard batch size
min_batch_sizenumericNoMinimum batch
max_batch_sizenumericNoMaximum batch
batch_uomtextNoBatch unit
expected_yield_pctnumericNoExpected yield %
requires_batch_recordbooleanNoProduces a batch record
requires_signaturebooleanNoRequires signatures
gmp_classtextNoGMP class
change_order_iduuidNoAuthorized by change order
effective_fromdateNoEffective from
effective_todateNoEffective to
notestextNoNotes

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

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

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

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

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/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

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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
recipe_notextread onlyRecipe no
nametextread, writeName
item_iduuidread, writeItem
versiontextread, writeVersion
bom_iduuidread, writeBill of material
routing_iduuidread, writeRouting
standard_batch_sizenumericread, writeStandard batch size
min_batch_sizenumericread, writeMinimum batch
max_batch_sizenumericread, writeMaximum batch
batch_uomtextread, writeBatch unit
expected_yield_pctnumericread, writeExpected yield %
requires_batch_recordbooleanread, writeProduces a batch record
requires_signaturebooleanread, writeRequires signatures
gmp_classtextread, writeGMP class
change_order_iduuidread, writeAuthorized by change order
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
statustextread onlyStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
notestextread, writeNotes
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 › Master Recipes 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.