Skip to main content
GET
/
v1
/
companies
/
{company-id}
/
settlements
/
receivables
Retrieve receivable Settlements visible to a Company
curl --request GET \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/settlements/receivables \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "adjustments_total_amount": "<string>",
      "data": {
        "friendly_order_ids": [
          "<string>"
        ],
        "quantities_per_uom": [
          "<string>"
        ]
      },
      "exported_at": "2023-11-07T05:31:56Z",
      "jobs_count": 123,
      "state": "pending",
      "total_amount": "<string>",
      "settlement_id": "<string>",
      "ar_settlement_id": "<string>",
      "ap_settlement_id": "<string>",
      "settlement_line_item_type": "order",
      "settlement_line_item_groupings": [
        "material"
      ],
      "add_on_charges_total_amount": "<string>",
      "invoices_total_amount": "<string>",
      "state_events": [
        "approve"
      ],
      "editable": true,
      "void_reason": "<string>",
      "rebillable": true,
      "rebill_total_amount": "<string>",
      "rebill_add_on_charges_total_amount": "<string>",
      "rebill_invoices_total_amount": "<string>",
      "voided_at": "2023-11-07T05:31:56Z",
      "approved": true,
      "approvable": true,
      "unapprovable": true,
      "billing_approved_at": "2023-11-07T05:31:56Z",
      "delivered_quantities": [
        {
          "delivered": "<string>",
          "unit_of_measure": "Load",
          "material_name": "<string>",
          "total": "<string>",
          "ticketed": true
        }
      ],
      "include_loads_in_pdf": true,
      "invoices_tax_total_amount": "<string>",
      "rebill_invoices_tax_total_amount": "<string>",
      "customer_account": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discarded_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "account_types": [
          "customer"
        ],
        "external_id": "<string>",
        "accounting_id": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "schedule_on": true,
        "billing_address": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "thoroughfare": "<string>",
          "premise": "<string>",
          "locality": "<string>",
          "administrative_area": "<string>",
          "postal_code": "<string>",
          "country": "US",
          "lat": "<string>",
          "lon": "<string>",
          "place_id": "<string>"
        },
        "connected_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "billing_contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      },
      "vendor_account": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "discarded_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "account_types": [
          "customer"
        ],
        "external_id": "<string>",
        "accounting_id": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "schedule_on": true,
        "billing_address": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "thoroughfare": "<string>",
          "premise": "<string>",
          "locality": "<string>",
          "administrative_area": "<string>",
          "postal_code": "<string>",
          "country": "US",
          "lat": "<string>",
          "lon": "<string>",
          "place_id": "<string>"
        },
        "connected_company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "billing_contact": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "email": "<string>",
          "phone": "+18885551234"
        }
      },
      "driver": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "company": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        },
        "schedule_on": true,
        "phone": "<string>",
        "managed": true,
        "gps_status": {
          "status": "online",
          "last_ping_at": "2023-11-07T05:31:56Z"
        },
        "email": "<string>",
        "company_share": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "ticket_match_id": "<string>",
          "sender_company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tread_id": "ABC123",
            "legal_name": "<string>",
            "company_type": "hauler"
          },
          "dispatchable": true,
          "schedule_on": true,
          "rate_override": true,
          "expires_at": "2023-11-07T05:31:56Z",
          "default_equipment": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "external_id": "<string>",
            "equipment_type": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "system": true,
              "external_id": "<string>",
              "accounting_id": "<string>"
            },
            "equipment_id": "<string>",
            "company_share": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "external_id": "<string>",
              "ticket_match_id": "<string>",
              "sender_company": {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "tread_id": "ABC123",
                "legal_name": "<string>",
                "company_type": "hauler"
              },
              "dispatchable": true,
              "schedule_on": true,
              "rate_override": true,
              "expires_at": "2023-11-07T05:31:56Z"
            }
          }
        },
        "equipment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "equipment_type": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "system": true,
            "external_id": "<string>",
            "accounting_id": "<string>"
          },
          "external_id": "<string>",
          "equipment_id": "<string>",
          "license_number": "<string>",
          "zone": "<string>",
          "accounting_id": "<string>",
          "company_share": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "ticket_match_id": "<string>",
            "sender_company": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "tread_id": "ABC123",
              "legal_name": "<string>",
              "company_type": "hauler"
            },
            "dispatchable": true,
            "schedule_on": true,
            "rate_override": true,
            "expires_at": "2023-11-07T05:31:56Z"
          }
        },
        "default_equipment": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "equipment_type": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "system": true,
            "external_id": "<string>",
            "accounting_id": "<string>"
          },
          "external_id": "<string>",
          "equipment_id": "<string>",
          "license_number": "<string>",
          "zone": "<string>",
          "accounting_id": "<string>",
          "company_share": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "external_id": "<string>",
            "ticket_match_id": "<string>",
            "sender_company": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "tread_id": "ABC123",
              "legal_name": "<string>",
              "company_type": "hauler"
            },
            "dispatchable": true,
            "schedule_on": true,
            "rate_override": true,
            "expires_at": "2023-11-07T05:31:56Z"
          }
        },
        "company_day_driver_stat": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "day": "2023-12-25",
          "jobs_count": 123
        },
        "labels": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "color": "<string>"
          }
        ]
      },
      "last_settlement_email_delivery": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "jsmith@example.com",
        "sender_user": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "first_name": "<string>",
          "last_name": "<string>",
          "discarded_at": "2023-11-07T05:31:56Z",
          "company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tread_id": "ABC123",
            "legal_name": "<string>",
            "company_type": "hauler"
          }
        },
        "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "state": "initiated",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "original_settlement": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "settlement_id": "<string>",
        "ar_settlement_id": "<string>",
        "ap_settlement_id": "<string>"
      },
      "agave_settlement_export": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "state": "not_exported",
        "agave_invoice_id": "<string>",
        "exported_at": "2023-11-07T05:31:56Z",
        "last_error": "<string>",
        "exported_by": {
          "type": "User",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "tread_id": "ABC123",
          "legal_name": "<string>",
          "company_type": "hauler"
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.tread.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

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

​
filter[states]
array

States based on the resource (e.g. Order states or Job states)

​
filter[start_date]
string

Start date range

​
filter[end_date]
string

End date range

​
filter[rate_types]
array

Array of rate types to filter by

​
filter[project_ids]
array

The associated Project IDs

​
filter[vendor_account_ids]
array

The associated Vendor Account IDs

​
filter[pickup_site_ids]
array

The associated Pickup Site IDs

​
sort[created_at]
string

Sort by Created At timestamp asc or desc

​
search[datagrid]
string

Search string for datagrid queries

Response

OK

​
data
Settlement-Read · object[]
required