Skip to main content
PATCH
Update a Settlement

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Path Parameters

id
string
required

Settlement ID

Body

application/json
settlement_line_item_type
enum<string>
default:load
Available options:
order,
job,
load
Example:

"order"

settlement_line_item_groupings
enum<string>[]
Available options:
material,
equipment_type,
service
include_loads_in_pdf
boolean

Controls whether load details are included in settlement PDFs

exported_at
string<date-time> | null

Timestamp when the settlement was exported. Use to manually mark a settlement as exported when no accounting integrations are connected.

Response

OK

data
Settlement-Read · object
required