TRANXACT.AI Help

Supply Chain · Freight Settlement

Freight Invoices

The carrier bill, matched against what was agreed. Freight audit is the highest-return process in transportation and it is nothing more than comparing three numbers.

Type REST12 operationsBase path /api/scm/freight-invoicesPublished as /api/v1/freight-invoices

Download specification (OpenAPI 3.1) Screen: Freight Invoices

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 › Freight Invoices 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.freight_invoices · 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

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

GET/api/scm/freight-invoicesList freight invoices

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",
      "invoice_no": "INV-000001",
      "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "carrier_invoice_no": "CAR-000001",
      "invoice_date": "2026-10-30",
      "due_date": "2026-10-30",
      "currency": "USD",
      "invoiced_amount": "1250.00",
      "expected_amount": "1250.00",
      "approved_amount": "1250.00",
      "variance_amount": "1250.00",
      "variance_pct": "1250.00",
      "ap_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "invoice_no": "INV-000001",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_invoice_no": "CAR-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30",
  "currency": "USD",
  "invoiced_amount": "1250.00",
  "expected_amount": "1250.00",
  "approved_amount": "1250.00",
  "variance_amount": "1250.00",
  "variance_pct": "1250.00",
  "ap_invoice_id": "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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-invoicesCreate a freight invoice

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
carrier_iduuidYesCarrier
carrier_invoice_notextNoTheir invoice number
invoice_datedateNoInvoice date
due_datedateNoDue date
currencytextNoCurrency
invoiced_amountnumericNoAmount billed
approved_amountnumericNoAmount approved
cost_center_iduuidNoCost center
dispute_reasontextNoDispute
disputed_amountnumericNoDisputed amount
notestextNoNotes

Sample body

{
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_invoice_no": "CAR-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30",
  "currency": "USD"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "invoice_no": "INV-000001",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_invoice_no": "CAR-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30",
  "currency": "USD",
  "invoiced_amount": "1250.00",
  "expected_amount": "1250.00",
  "approved_amount": "1250.00",
  "variance_amount": "1250.00",
  "variance_pct": "1250.00",
  "ap_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/freight-invoices" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_invoice_no":"CAR-000001","invoice_date":"2026-10-30","due_date":"2026-10-30","currency":"USD"}'
PUT/api/scm/freight-invoices/{id}Change a freight invoice

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
carrier_iduuidYesCarrier
carrier_invoice_notextNoTheir invoice number
invoice_datedateNoInvoice date
due_datedateNoDue date
currencytextNoCurrency
invoiced_amountnumericNoAmount billed
approved_amountnumericNoAmount approved
cost_center_iduuidNoCost center
dispute_reasontextNoDispute
disputed_amountnumericNoDisputed amount
notestextNoNotes

Sample body

{
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_invoice_no": "CAR-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "invoice_no": "INV-000001",
  "carrier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "carrier_invoice_no": "CAR-000001",
  "invoice_date": "2026-10-30",
  "due_date": "2026-10-30",
  "currency": "USD",
  "invoiced_amount": "1250.00",
  "expected_amount": "1250.00",
  "approved_amount": "1250.00",
  "variance_amount": "1250.00",
  "variance_pct": "1250.00",
  "ap_invoice_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/scm/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"carrier_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","carrier_invoice_no":"CAR-000001"}'
DELETE/api/scm/freight-invoices/{id}Delete a freight invoice

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

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

tolerancePct, toleranceAmount

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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/audit" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"tolerancePct":"value","toleranceAmount":"value"}'
POST/api/scm/freight-invoices/{id}/postPost

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

approvedAmount, costCenterId

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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"approvedAmount":"value","costCenterId":"value"}'
GET/api/scm/freight-invoices/{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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-invoices/{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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/scm/freight-invoices/{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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/scm/freight-invoices/{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/freight-invoices/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a freight invoice, 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
invoice_notextread onlyInvoice no
carrier_iduuidread, writeCarrier
carrier_invoice_notextread, writeTheir invoice number
invoice_datedateread, writeInvoice date
due_datedateread, writeDue date
currencytextread, writeCurrency
invoiced_amountnumericread, writeAmount billed
expected_amountnumericread onlyExpected amount
approved_amountnumericread, writeAmount approved
variance_amountnumericread onlyVariance amount
variance_pctnumericread onlyVariance pct
ap_invoice_iduuidread onlyAp invoice id
cost_center_iduuidread, writeCost center
posted_attimestamp with time zoneread onlyPosted at
dispute_reasontextread, writeDispute
disputed_amountnumericread, writeDisputed amount
dispute_opened_attimestamp with time zoneread onlyDispute opened at
dispute_closed_attimestamp with time zoneread onlyDispute closed at
statustextread onlyStatus
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 Supply Chain › Freight Invoices 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.