TRANXACT.AI Help

Supply Chain · Procurement Control

Procurement Exceptions

Everything between a customer order and the material it needs that is not moving — unapproved requisitions, unawarded tenders, late deliveries, rejected material, overdue subcontractors and invoices that will not match.

Type REST6 operationsBase path /api/scm/procurement-exceptionsPublished as /api/v1/procurement-exceptions

Download specification (OpenAPI 3.1) Screen: Procurement Exceptions

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 › Procurement Exceptions 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.procurement_exceptions · kept per company (and organisational unit where it has one)
RecordRead only; key ref_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/scm/procurement-exceptionsList procurement exceptions

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": [
    {
      "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "ref_kind": "text",
      "ref_no": "REF-000001",
      "exception_kind": "text",
      "description": "text",
      "required_date": "2026-10-30",
      "value": "1250.00",
      "currency": "USD",
      "so_no": "SO-000001",
      "account_name": "Example",
      "supplier_name": "Example",
      "since": "2026-10-30T09:00:00Z",
      "severity": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
ref_idstring (uuid)The record's ref_id, as a list returns it.

Response 200

{
  "ref_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "ref_kind": "text",
  "ref_no": "REF-000001",
  "exception_kind": "text",
  "description": "text",
  "required_date": "2026-10-30",
  "value": "1250.00",
  "currency": "USD",
  "so_no": "SO-000001",
  "account_name": "Example",
  "supplier_name": "Example",
  "since": "2026-10-30T09:00:00Z",
  "severity": "text"
}

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

Sample request

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

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/procurement-exceptions" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/procurement-exceptions/{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/procurement-exceptions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/scm/procurement-exceptions/{id}Put procurement exceptions

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

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

Data model

Every field of a procurement exception, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
ref_iduuidread onlyRef id
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
ref_kindtextread onlyRef kind
ref_notextread onlyRef no
exception_kindtextread onlyException kind
descriptiontextread onlyDescription
required_datedateread onlyRequired date
valuenumericread onlyValue
currencytextread onlyCurrency
so_notextread onlySo no
account_nametextread onlyAccount name
supplier_nametextread onlySupplier name
sincetimestamp with time zoneread onlySince
severitytextread onlySeverity

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 › Procurement Exceptions 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.