TRANXACT.AI Help

Manufacturing · Material Availability

Availability · Lines

Line by line: what is on hand, what of that is already promised, what is on order, what is on a production order, and what is genuinely short. The four are kept apart because “we have none” and “it is all promised elsewhere” want different things done about them.

Type REST6 operationsBase path /api/mfg/availability-linesPublished as /api/v1/availability-lines

Download specification (OpenAPI 3.1) Screen: Availability · Lines

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 · Lines 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_lines
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

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

GET/api/mfg/availability-linesList availability · lines

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",
      "check_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "component_kind": "text",
      "required_qty": "12.0000",
      "uom": "text",
      "required_date": "2026-10-30",
      "on_hand_qty": "12.0000",
      "allocated_qty": "12.0000",
      "on_order_qty": "12.0000",
      "on_production_qty": "12.0000",
      "available_qty": "12.0000",
      "shortage_qty": "12.0000"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "check_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "item_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "component_kind": "text",
  "required_qty": "12.0000",
  "uom": "text",
  "required_date": "2026-10-30",
  "on_hand_qty": "12.0000",
  "allocated_qty": "12.0000",
  "on_order_qty": "12.0000",
  "on_production_qty": "12.0000",
  "available_qty": "12.0000",
  "shortage_qty": "12.0000"
}

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

Sample request

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

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-lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/availability-lines/{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-lines/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/availability-lines/{id}Put availability · lines

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

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/availability-lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a availability line, 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
check_iduuidread onlyCheck id
line_nointegerread onlyLine no
item_iduuidread onlyItem id
component_kindtextread onlyComponent kind
required_qtynumericread onlyRequired qty
uomtextread onlyUom
required_datedateread onlyRequired date
on_hand_qtynumericread onlyOn hand qty
allocated_qtynumericread onlyAllocated qty
on_order_qtynumericread onlyOn order qty
on_production_qtynumericread onlyOn production qty
available_qtynumericread onlyAvailable qty
shortage_qtynumericread onlyShortage qty
expected_datedateread onlyExpected date
unit_costnumericread onlyUnit cost
actiontextread onlyAction
alternate_item_iduuidread onlyAlternate item id
reservation_iduuidread onlyReservation id
requisition_line_iduuidread onlyRequisition line id
resolved_component_iduuidread onlyResolved component id
notestextread onlyNotes
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 · Lines 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.