TRANXACT.AI Help

Supply Chain · Requisitions & Orders

Requisitions

Read and maintain requisitions records (scm.requisitions).

Type REST20 operationsBase path /api/scm/requisitionsPublished as /api/v1/requisitions

Download specification (OpenAPI 3.1) Screen: Requisitions

Overview

PackageSupply Chain
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 Supply Chain › Requisitions 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.
Tablescm.requisitions · 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

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

GET/api/scm/requisitionsList requisitions

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",
      "req_no": "REQ-000001",
      "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "need_by_date": "2026-10-30",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "draft",
      "notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cancelled_at": "2026-10-30T09:00:00Z",
      "cancelled_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "req_no": "REQ-000001",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "need_by_date": "2026-10-30",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cancelled_at": "2026-10-30T09:00:00Z",
  "cancelled_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitionsCreate a requisitions

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
need_by_datedateNoNeed-by date
statustextNoStatus
notestextNoNotes
currencytextNoCurrency
categorytextNoCategory — Decides which technical department assesses it, which approval rule applies, and which vendors the enquiry goes to.
departmenttextNoFor department
exchange_ratenumericNoExchange rate
project_iduuidNoProject

Sample body

{
  "need_by_date": "2026-10-30",
  "status": "draft",
  "notes": "text",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "req_no": "REQ-000001",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "need_by_date": "2026-10-30",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cancelled_at": "2026-10-30T09:00:00Z",
  "cancelled_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/requisitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"need_by_date":"2026-10-30","status":"draft","notes":"text","currency":"USD"}'
PUT/api/scm/requisitions/{id}Change a requisitions

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
need_by_datedateNoNeed-by date
statustextNoStatus
notestextNoNotes
currencytextNoCurrency
categorytextNoCategory — Decides which technical department assesses it, which approval rule applies, and which vendors the enquiry goes to.
departmenttextNoFor department
exchange_ratenumericNoExchange rate
project_iduuidNoProject

Sample body

{
  "need_by_date": "2026-10-30",
  "status": "draft"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "req_no": "REQ-000001",
  "requested_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "need_by_date": "2026-10-30",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "draft",
  "notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profit_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cancelled_at": "2026-10-30T09:00:00Z",
  "cancelled_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"need_by_date":"2026-10-30","status":"draft"}'
DELETE/api/scm/requisitions/{id}Delete a requisitions

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

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approvals" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitions/{id}/submitSubmit

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

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/trace" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitions/{id}/rfqRfq

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

rfxType, title, description, closesAt; rfxType one of rfi|rfp|rfq|tender; criteria: [{ code, name, kind, weight, higherIsBetter, maxScore, mandatory }]

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rfq" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"rfxType":"value","title":"value","description":"value","closesAt;":"value","name":"value","kind":"value"}'
POST/api/scm/requisitions/{id}/purchase-orderPurchase order

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

supplierId, 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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/purchase-order" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"value","currency":"value","exchangeRate":"value"}'
GET/api/scm/requisitions/source-forSource for

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/scm/requisitions/source-for" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitions/{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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/scm/requisitions/{parentId}/linesLines

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

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

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/requisitions/{parentId}/lines/{lineId}Lines

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/scm/requisitions/{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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitions/create-with-linesCreate with lines

Request body

The keys this action reads (* = required; "one of" lists the only values):

projectId, project_id, orgUnitId, documentNo, needByDate, costCenterId, profitCenterId, locationId, warehouseId, notes, currency, exchangeRate, category, department; lines*: [{ uom, itemId, currency, exchangeRate, suggestedSupplierId, suggested_supplier_id, quantity, estPrice, costCenterId, base }]; optional, filled by the server when left out (do not ask for them): needByDate, costCenterId, locationId, warehouseId, category, department, currency, exchangeRate, lines[].estPrice, lines[].uom

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/scm/requisitions/create-with-lines" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"value","project_id":"value","orgUnitId":"value","documentNo":"value","needByDate":"value","costCenterId":"value"}'
GET/api/scm/requisitions/{id}/sourcing-awardSourcing award

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sourcing-award" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/requisitions/{id}/approve-and-convertApprove and convert

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

supplierId

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/scm/requisitions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve-and-convert" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"supplierId":"value"}'

Data model

Every field of a requisitions, 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
req_notextread onlyReq no
requested_byuuidread onlyRequested by
need_by_datedateread, writeNeed-by date
cost_center_iduuidread onlyCost center id
statustextread, writeStatus
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
location_iduuidread onlyLocation
warehouse_iduuidread onlyDeliver to warehouse
profit_center_iduuidread onlyProfit center id
cancelled_attimestamp with time zoneread onlyCancelled at
cancelled_byuuidread onlyCancelled by
cancel_reasontextread onlyCancel reason
reversed_by_iduuidread onlyReversed by id
reverses_iduuidread onlyReverses id
req_typetextread onlyReq type
origintextread onlyOrigin
account_iduuidread onlyAccount id
sales_order_iduuidread onlySales order id
config_iduuidread onlyConfig id
production_order_iduuidread onlyProduction order id
availability_check_iduuidread onlyAvailability check id
inspection_iduuidread onlyInspection id
currencytextread, writeCurrency
total_valuenumericread onlyTotal value
categorytextread, writeCategory — Decides which technical department assesses it, which approval rule applies, and which vendors the enquiry goes to.
departmenttextread, writeFor department
approval_statustextread onlyApproval status
submitted_attimestamp with time zoneread onlySubmitted at
submitted_byuuidread onlySubmitted by
approved_attimestamp with time zoneread onlyApproved at
production_operation_iduuidread onlyProduction operation id
exchange_ratenumericread, writeExchange rate
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
project_iduuidread, writeProject

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 Supply Chain › Requisitions 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.