Guides
Changelog
Back to All
Added

New Public API Settlement Statement Endpoints

about 5 hours ago

We've added Public API support for finalized driver, owner-operator, and carrier settlement statements. Partners can now pull statement headers, totals, and full line-item detail programmatically — making it easier to build custom reporting and reconciliation workflows without manually exporting the "Statements List and Items" report.

What's New

  • Search finalized driver and owner-operator settlement statements with paging, line items, and totals.
  • Search finalized carrier settlement statements with paging, per-trip breakdowns, line items, payments, and totals.
  • Fetch a single driver, owner-operator, or carrier settlement statement by statement number.
  • Filter statement searches by statement-date range, driver type, carrier, and subsidiary.

What Changes

  • This release is additive and backward compatible.

  • Only finalized statements from the Statements tab are returned. Open and Draft statements are excluded.

  • Driver settlement statements may include Failed statements; these are identified through the Status field.

  • Carrier settlement statements exclude Failed and Deleted statements.

  • StatementDateRange is required for search requests. Both Start and End must be provided and are interpreted as inclusive UTC calendar days.

  • The driver DriverType filter accepts COMPANY, OWNER_OPERATOR, or CONTRACTOR, case-insensitive, matching the /drivers endpoint.

  • Monetary values are returned as { Amount, Currency } objects.

  • Access uses existing scopes:

    • driver:read for driver settlement statements
    • carrier:read for carrier settlement statements

Endpoints Affected

  • POST /p/v1.0/driver-settlement-statements/search (new) — search finalized driver and owner-operator settlement statements.
  • GET /p/v1.0/driver-settlement-statements/{number} (new) — fetch a single driver or owner-operator settlement statement by statement number.
  • POST /p/v1.0/carrier-settlement-statements/search (new) — search finalized carrier settlement statements.
  • GET /p/v1.0/carrier-settlement-statements/{number} (new) — fetch a single carrier settlement statement by statement number.