TRANXACT.AI Help

Manufacturing · Material Availability

Availability Checks

The question “can this be made”, asked of a sales order or a configuration, and the answer as it stood at that moment. Kept as a document because the shortage it found is what a requisition was raised from.

Type REST9 operationsBase path /api/mfg/availability-checksPublished as /api/v1/availability-checks

Download specification (OpenAPI 3.1) Screen: Availability Checks

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 › Availability Checks 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.availability_checks · 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

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

GET/api/mfg/availability-checksList availability checks

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",
      "check_no": "CHE-000001",
      "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "sales_order_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "quantity": "12.0000",
      "required_date": "2026-10-30",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "draft",
      "line_count": 10
    }
  ],
  "count": 1
}

Sample request

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

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",
  "check_no": "CHE-000001",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "required_date": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "line_count": 10
}

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

Sample request

curl "https://demo.tranxact.ai/api/mfg/availability-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/availability-checksCreate a availability check

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
check_notextYesCheck no
sales_order_iduuidNoSales order
sales_order_line_iduuidNoSales order line id
config_iduuidNoConfiguration
production_order_iduuidNoProduction order
account_iduuidNoAccount id
item_iduuidNoItem id
quantitynumericNoQuantity
required_datedateNoNeeded by
warehouse_iduuidNoWarehouse
statustextNoStatus
notestextNoNotes

Sample body

{
  "check_no": "CHE-000001",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "check_no": "CHE-000001",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "required_date": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "line_count": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/mfg/availability-checks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"check_no":"CHE-000001","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sales_order_line_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","config_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","production_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/mfg/availability-checks/{id}Change a availability check

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
check_notextYesCheck no
sales_order_iduuidNoSales order
sales_order_line_iduuidNoSales order line id
config_iduuidNoConfiguration
production_order_iduuidNoProduction order
account_iduuidNoAccount id
item_iduuidNoItem id
quantitynumericNoQuantity
required_datedateNoNeeded by
warehouse_iduuidNoWarehouse
statustextNoStatus
notestextNoNotes

Sample body

{
  "check_no": "CHE-000001",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "check_no": "CHE-000001",
  "sales_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sales_order_line_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "config_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "production_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "quantity": "12.0000",
  "required_date": "2026-10-30",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "line_count": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/mfg/availability-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"check_no":"CHE-000001","sales_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/mfg/availability-checks/{id}Delete a availability check

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

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/availability-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/availability-checks/{id}/allocateAllocate

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/availability-checks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/allocate" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/availability-checks/{id}/requisitionRequisition

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

currency, exchangeRate

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

Data model

Every field of a availability check, 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
check_notextread, writeCheck no
sales_order_iduuidread, writeSales order
sales_order_line_iduuidread, writeSales order line id
config_iduuidread, writeConfiguration
production_order_iduuidread, writeProduction order
account_iduuidread, writeAccount id
item_iduuidread, writeItem id
quantitynumericread, writeQuantity
required_datedateread, writeNeeded by
warehouse_iduuidread, writeWarehouse
statustextread, writeStatus
line_countintegerread onlyLine count
short_countintegerread onlyShort count
shortage_valuenumericread onlyShortage value
can_promise_datedateread onlyCan promise date
checked_byuuidread onlyChecked by
checked_attimestamp with time zoneread onlyChecked at
notestextread, writeNotes
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_attimestamp with time zoneread onlyCreated at
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 › Availability Checks 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.