Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
settlements
/
{settlement-id}
/
add_on_charges
Retrieve AddOnCharges for a Settlement (company-scoped)
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/settlements/{settlement-id}/add_on_charges \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "percentage": "<string>",
      "quantity": "<string>",
      "total_amount": "<string>",
      "external_id": "<string>",
      "revenue_rate_value": "<string>",
      "revenue_cost_rate_type": "RateForEach",
      "add_on_requestable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "add_on_applicable_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accounting_id": "<string>",
      "rate": "<string>",
      "add_on_rate_type": "RateForEach",
      "rebill_revenue_rate_value": "<string>",
      "rebill_total_amount": "<string>",
      "add_on": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "invoice": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "load": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "job": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "job_id": "<string>",
        "loads_count": 123,
        "job_start_at": "2023-11-07T05:31:56Z",
        "unit_of_measure": "Load"
      },
      "rebill_percentage": "<string>"
    }
  ]
}

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

​
company-id
string<uuid>
required

Company ID

​
settlement-id
string
required

Settlement ID

Query Parameters

​
page[limit]
integer<int32>
default:25

The maximum number of paginated results to return

Required range: x <= 100
​
page[after]
string

The cursor to start paginating after

​
page[before]
string

The cursor to stop paginating at

Response

OK

​
data
AddOnCharge-Read · object[]
required