TRANXACT.AI Help

Supply Chain · Freight Forwarding

Freight Charges

The priced detail: linehaul, fuel, each accessorial, on its own line. Both what it was bought at and what it is sold at, because the difference is the whole business model of a forwarder.

Type REST6 operationsBase path /api/scm/freight-chargesPublished as /api/v1/freight-charges

Download specification (OpenAPI 3.1) Screen: Freight Charges

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 Charges 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_charges · 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

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

GET/api/scm/freight-chargesList freight charges

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",
      "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "line_no": 10,
      "charge_code": "CHA-000001",
      "description": "text",
      "accessorial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "charge_kind": "linehaul",
      "buy_amount": "1250.00",
      "sell_amount": "1250.00",
      "quantity": "12.0000",
      "unit_rate": "1250.00",
      "currency": "USD",
      "exchange_rate": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_code": "CHA-000001",
  "description": "text",
  "accessorial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "charge_kind": "linehaul",
  "buy_amount": "1250.00",
  "sell_amount": "1250.00",
  "quantity": "12.0000",
  "unit_rate": "1250.00",
  "currency": "USD",
  "exchange_rate": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
freight_order_iduuidNoFreight order
forwarding_shipment_iduuidNoForwarding shipment
line_nointegerNoLine
charge_codetextYesCharge code
descriptiontextNoDescription
accessorial_iduuidNoAccessorial
charge_kindtextNoKind
Allowed: linehaul fuel accessorial customs duty insurance handling detention demurrage storage tax other
buy_amountnumericNoBought at
sell_amountnumericNoSold at
quantitynumericNoQuantity
unit_ratenumericNoUnit rate
currencytextNoCurrency
exchange_ratenumericNoExchange rate
is_billablebooleanNoRecharged to the customer
gl_account_iduuidNoPosts to
cost_center_iduuidNoCost center
statustextNoStatus
Allowed: estimated accrued invoiced disputed settled cancelled

Sample body

{
  "charge_code": "CHA-000001",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "description": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_code": "CHA-000001",
  "description": "text",
  "accessorial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "charge_kind": "linehaul",
  "buy_amount": "1250.00",
  "sell_amount": "1250.00",
  "quantity": "12.0000",
  "unit_rate": "1250.00",
  "currency": "USD",
  "exchange_rate": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/scm/freight-charges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"charge_code":"CHA-000001","freight_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","forwarding_shipment_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","line_no":10,"description":"text"}'
PUT/api/scm/freight-charges/{id}Change a freight charge

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
freight_order_iduuidNoFreight order
forwarding_shipment_iduuidNoForwarding shipment
line_nointegerNoLine
charge_codetextYesCharge code
descriptiontextNoDescription
accessorial_iduuidNoAccessorial
charge_kindtextNoKind
Allowed: linehaul fuel accessorial customs duty insurance handling detention demurrage storage tax other
buy_amountnumericNoBought at
sell_amountnumericNoSold at
quantitynumericNoQuantity
unit_ratenumericNoUnit rate
currencytextNoCurrency
exchange_ratenumericNoExchange rate
is_billablebooleanNoRecharged to the customer
gl_account_iduuidNoPosts to
cost_center_iduuidNoCost center
statustextNoStatus
Allowed: estimated accrued invoiced disputed settled cancelled

Sample body

{
  "charge_code": "CHA-000001",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "freight_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "forwarding_shipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "line_no": 10,
  "charge_code": "CHA-000001",
  "description": "text",
  "accessorial_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "charge_kind": "linehaul",
  "buy_amount": "1250.00",
  "sell_amount": "1250.00",
  "quantity": "12.0000",
  "unit_rate": "1250.00",
  "currency": "USD",
  "exchange_rate": "1250.00"
}

Sample request

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

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-charges/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/scm/freight-charges/{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-charges/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 freight charge, 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
freight_order_iduuidread, writeFreight order
forwarding_shipment_iduuidread, writeForwarding shipment
line_nointegerread, writeLine
charge_codetextread, writeCharge code
descriptiontextread, writeDescription
accessorial_iduuidread, writeAccessorial
charge_kindtextread, writeKind
Allowed: linehaul fuel accessorial customs duty insurance handling detention demurrage storage tax other
buy_amountnumericread, writeBought at
sell_amountnumericread, writeSold at
quantitynumericread, writeQuantity
unit_ratenumericread, writeUnit rate
currencytextread, writeCurrency
exchange_ratenumericread, writeExchange rate
is_billablebooleanread, writeRecharged to the customer
gl_account_iduuidread, writePosts to
cost_center_iduuidread, writeCost center
statustextread, writeStatus
Allowed: estimated accrued invoiced disputed settled cancelled
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 Charges 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.