How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
tread.io

tread.io Settlements API

The Settlements API from tread.io — 35 operation(s) for settlements.

Documentation Provider Profile APIs.io OpenAPI GitHub

tread.io Settlements API is one of 58 APIs that tread.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Settlement. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 37 operations across 35 paths, and defines 94 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.tread-horizon.com.

37 operations 35 paths 94 schemas 12 GET2 PATCH7 POST16 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.tread-horizon.com
Authentication
HTTP Bearer
Contact
Tread
License
Private
Resource Areas
1

Authentication & Security 1

tread.io Settlements API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 37

Across 35 paths, the API surfaces 37 operations — 12 GET, 2 PATCH, 7 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.

Settlements 37
POST
/v1/companies/{company-id}/settlements
Create a Settlement for a Company
post-v1-companies-company-id-settlements 2 params body → 201400401403404406415422
POST
/v1/companies/{company-id}/settlements/bulk_create
Bulk Create Settlements
post-v1-companies-company-id-settlements-bulk_create 2 params body → 202400401403406415422
GET
/v1/companies/{company-id}/settlements/payables
Retrieve payable Settlements visible to a Company
get-v1-companies-company-id-settlements-payables 14 params → 200401404406422
GET
/v1/companies/{company-id}/settlements/receivables
Retrieve receivable Settlements visible to a Company
get-v1-companies-company-id-settlements-receivables 14 params → 200401404406422
GET
/v1/companies/{company-id}/settlements/{id}
Retrieve a Settlement for a Company
get-v1-companies-company-id-settlements-id 3 params → 200401404406
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/approve
Approve a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-approve 3 params body → 200400401403404406409415
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/customer_pay
Pay a Settlement as the Customer for a Company
put-v1-companies-company-id-settlements-settlement-id-customer_pay 3 params → 200400401403404406409415
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/email_settlement
Email a Settlement (Company-scoped)
put-v1-companies-company-id-settlements-settlement-id-email_settlement 3 params body → 204401403404406415422
POST
/v1/companies/{company-id}/settlements/{settlement-id}/export
Export Settlement to Agave
post-v1-companies-company-id-settlements-settlement-id-export 3 params → 202400401403404406415422
GET
/v1/companies/{company-id}/settlements/{settlement-id}/invoices
Get Invoices for a Settlement for a Company
get-v1-companies-company-id-settlements-settlement-id-invoices 6 params → 200401404406
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/pay
Pay a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-pay 3 params body → 200400401403404406409415
POST
/v1/companies/{company-id}/settlements/{settlement-id}/rebill
Rebill a Settlement for a Company
post-v1-companies-company-id-settlements-settlement-id-rebill 3 params → 201401403404406422
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/send_settlement
Send a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-send_settlement 3 params body → 200400401403404406409415
GET
/v1/companies/{company-id}/settlements/{settlement-id}/settlement_email_deliveries
Get SettlementEmailDeliveries for a Settlement as a Company
get-v1-companies-company-id-settlements-settlement-id-settlement_email_deliveries 6 params → 200401404406
GET
/v1/companies/{company-id}/settlements/{settlement-id}/settlement_line_items
Retrieve all SettlementLineItems that belongs to a Settlement as a Company
get-v1-companies-company-id-settlements-settlement-id-settlement_line_items 4 params body → 200401404406422
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/unapprove
Unapprove a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-unapprove 3 params → 200401403404406409
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/undo_pay
Undo pay on a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-undo-pay 3 params body → 200400401403404406409415
PUT
/v1/companies/{company-id}/settlements/{settlement-id}/void
Void a Settlement as a Company
put-v1-companies-company-id-settlements-settlement-id-void 3 params body → 200400401403404406409415
POST
/v1/settlementsdeprecated
Create a Settlement
post-v1-settlements 1 param body → 201401403406415422
GET
/v1/settlements/payables
Retrieve payable Settlements visible to the current Company
get-v1-settlements-payables 12 params → 200401406422
GET
/v1/settlements/receivables
Retrieve receivable Settlements visible to the current Company
get-v1-settlements-receivables 12 params → 200401406422
GET
/v1/settlements/{id}
Retrieve a Settlement
get-v1-settlements-id 2 params → 200401404406
PATCH
/v1/settlements/{id}
Update a Settlement
patch-v1-settlements-settlement-id 2 params body → 200401403404406415422
PUT
/v1/settlements/{settlement-id}/approvedeprecated
Approve a Settlement
put-v1-settlements-settlement-id-approve 2 params body → 200400401403404406409415
PUT
/v1/settlements/{settlement-id}/customer_approve
Approve a Settlement as the Customer
put-v1-settlements-settlement-id-customer_approve 2 params body → 200400401403404406409415
PUT
/v1/settlements/{settlement-id}/customer_pay
Pay a Settlement as the Customer
put-v1-settlements-settlement-id-customer_pay 2 params body → 200400401403404406409415
PUT
/v1/settlements/{settlement-id}/email_settlementdeprecated
Email a Settlement
put-v1-settlements-settlement-id-email_settlement 2 params body → 204401403404406415422
POST
/v1/settlements/{settlement-id}/file_attachments
Create a FileAttachment on a Settlement
post-v1-settlements-settlement-id-file_attachments 2 params body → 201401403404406415422
GET
/v1/settlements/{settlement-id}/file_attachments
Retrieve all FileAttachments for a given Settlement
get-v1-settlements-settlement-id-file_attachments 5 params → 200401404406
PATCH
/v1/settlements/{settlement-id}/invoices/rebill_rates
Rebill Settlement's Invoices Rates
patch-v1-settlements-settlement-id-invoices-rebill_rates 2 params body → 200401403404406415422
PUT
/v1/settlements/{settlement-id}/paydeprecated
Pay a Settlement
put-v1-settlements-settlement-id-pay 2 params body → 200400401403404406409415
POST
/v1/settlements/{settlement-id}/rebilldeprecated
Generate new Settlement for Rebill
post-v1-settlements-settlement-id-rebill 2 params → 201400401403404406415422
PUT
/v1/settlements/{settlement-id}/send_settlementdeprecated
Send a Settlement
put-v1-settlements-settlement-id-send_settlement 2 params body → 200400401403404406409415
GET
/v1/settlements/{settlement-id}/settlement_email_deliveries
Get SettlementEmailDeliveries for a Settlement
get-v1-settlements-settlement-id-settlement_email_deliveries 5 params → 200401404406
GET
/v1/settlements/{settlement-id}/settlement_line_items
Retrieve all SettlementLineItems that belongs to a Settlement
get-v1-settlements-settlement-id-settlement_line_items 3 params body → 200401404406422
PUT
/v1/settlements/{settlement-id}/unapprovedeprecated
Unapprove a Settlement
put-v1-settlements-settlement-id-unapprove 2 params → 200401403404406409
PUT
/v1/settlements/{settlement-id}/voiddeprecated
Void a Settlement by ID
put-v1-settlements-settlement-id-void 2 params body → 200400401403404406409415

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are JobSummary-Read (33 properties), SettlementLineItem-Read (23 properties), Address-Read (9 properties), BulkSettlement-Create (7 properties). Each schema is shown below with its type and property counts.

CompanyDayDriverStat-Read
CompanyDayDriverStat
DeliveredQuantity-Read
object
5 properties 5 required
FileAttachment-Read
DispatchNumber-Read-Nested
InvoiceState
EquipmentType-Read-Nested
object
5 properties 5 required
DriverDay-Read-Nested
SettlementEmailDelivery-Read
Equipment-Read-Default-Nested
SettlementLineItemGrouping
Order-Read-Nested
RateCommission-Read-Nested
Invoice-Read
Deprecation notes: - job is deprecated in favor of invoiceable. - order is deprecated in favor of orderorderids - project is deprecated in favor of projectname…
Rate-Read-Nested
SettlementStateEvent
AgaveSettlementExport-Read-Nested
AccountType
ModelError-Response
object
1 property 1 required
Geofence-Data
object
5 properties
CompanyShare-Read-User-Nested
NullableRateType
stringnull
RateType
InvoiceLineItemType
SettlementEmailDeliveryState
User-Read-Minimal
CompanyType
Company Type
SettlementLineItem-Read
object
23 properties 15 required
SettlementState
OrderUnitOfMeasure
RateTime-Read-Nested
Impersonation-Read-Minimal
object
2 properties 2 required
Invoice-Job-Read-Nested
UnauthenticatedError-Response
object
1 property 1 required
Company-Read-Nested
Compact Company model for nested reads.
Settlement-Data
object
2 properties
RebillSettlementInvoiceRate-Update
object
2 properties 2 required
NullableGeofenceType
stringnull
StateError-Item
GeofenceTag
Job-Read-Nested
GpsStatus
object
GPS Ping status for a record
2 properties 2 required
RateFlatRate-Read-Nested
BulkSettlement-Create
object
7 properties 2 required
StateError
Material-Read-Nested
object
3 properties 3 required
Address-Read
object
9 properties 9 required
TreadId
object
1 property 1 required
JobAssignment-Read-Nested
ModelError-Item
object
3 properties 3 required
Equipment-Read-Typeahead
SettlementLineItemType
Site-Read-Nested
Contact-Read-Nested
Account-Read-Nested
M2MClient-Read-Nested
UnauthenticatedError
Identifier
object
1 property 1 required
Driver-Read-Typeahead
Equipment-Read-Nested
Discardable
object
1 property 1 required
NextBillionGeofence-Read
User-Read-Typeahead
Driver-Read-Nested
Settlement-Create
object
4 properties 1 required
StateError-Response
object
1 property 1 required
Timestamps
object
2 properties 2 required
EmailSettlement-Create
object
2 properties 2 required
NullableOrderUnitOfMeasure
stringnull
Invoiceable-Read-Nested
RatePerUnit-Read-Nested
Project-Read-Nested
Project-Read-Typeahead
GeofenceType
Settlement-Read
InvoiceStateEvent
GpsStatusable
object
1 property 1 required
Error
object
An Error.
1 property 1 required
Address-Read-Nested
RateFlatCommission-Read-Nested
SettlementLineItem-Group-Read
object
3 properties 1 required
FileAttachmentCategory
FileAttachableType
ModelError
A Model-specific error
Settlement-Update
object
4 properties
Invoice-Read-Nested
Principal-Read-Nested
Settlement-Read-Nested
FileAttachment-Create
object
3 properties 1 required
Error-Response
object
1 property 1 required
CompanyShare-Read-Nested
JobSummary-Read
object
33 properties 28 required
OrderState
AgaveExportState
string
The current state of the Agave export
Label-Read-Nested

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

treadio-settlements-api-openapi.yml Raw ↑

Other APIs tread.io publishes across the network.

tread.io AccountExternalTruckIdentifier API
AE Profile APIs.io
tread.io Accounts API
AE Profile APIs.io
tread.io AddOnCharges API
AE Profile APIs.io
tread.io AddOns API
AE Profile APIs.io
tread.io Agave API
AE Profile APIs.io
tread.io ApprovalAssignments API
AE Profile APIs.io
tread.io Authentication API
AE Profile APIs.io
tread.io AutoAddOnAssignments API
AE Profile APIs.io
tread.io Companies API
AE Profile APIs.io
tread.io CompanyDayJobStats API
AE Profile APIs.io
tread.io CompanyShares API
AE Profile APIs.io
tread.io Compliance API
AE Profile APIs.io
#Settlement
← Back to T APIs
API Details
ID
treadio:treadio-settlements-api
Base URL
https://api.tread-horizon.com
Docs
https://docs.tread.ai/api-reference/introduction
Provider
tread.io
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=treadio-settlements-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/treadio-settlements-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of tread.io Settlements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.