Batch update AddOnCharges for a Settlement

curl --request PATCH \
  --url https://api.tread-horizon.com/v1/settlements/{settlement-id}/add_on_charges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add_on_charges": [
    {
      "name": "<string>",
      "percentage": 0,
      "quantity": 123,
      "rate": 123,
      "add_on_rate_type": "RateForEach",
      "add_on_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "accounting_id": "<string>",
      "load_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revenue_rate_value": 123,
      "revenue_cost_rate_type": "RateForEach",
      "rebill_revenue_rate_value": 123,
      "rebill_percentage": 123,
      "cost_rate_value": 123
    }
  ]
}
'

{
  "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>"
    }
  ]
}

AddOnCharges

Batch update AddOnCharges for a Settlement

Batch update AddOnCharges for a Settlement

This endpoint allows updating, creating, deleting AddOnCharges all at once.

If updating existing records:

must provide the id for each record to be updated
only provide the fields to be updated e.g.

add_on_charges: [
  {
    "id": "some-uuid"
    "quantity": 20.25,
    "rate": 15.75
  }
]

If creating new records:

must not provide the id for each record to be created
provide all the fields needed for the record e.g.

add_on_charges: [
  {
    "quantity": 20.25,
    "rate": 12.5,
    "add_on_rate_type": "RateForEach"
  },
  {
    "percentage": 10,
    "add_on_rate_type": "RatePercentOfTotal"
  }
]

If deleting exisitng records:

must provide the id and the property _destroy: 1

e.g.

add_on_charges: [
  {
    "id": "some-uuid"
    "_destroy": 1
  }
]

PATCH

settlements

{settlement-id}

add_on_charges

Batch update AddOnCharges for a Settlement

curl --request PATCH \
  --url https://api.tread-horizon.com/v1/settlements/{settlement-id}/add_on_charges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "add_on_charges": [
    {
      "name": "<string>",
      "percentage": 0,
      "quantity": 123,
      "rate": 123,
      "add_on_rate_type": "RateForEach",
      "add_on_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "accounting_id": "<string>",
      "load_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "revenue_rate_value": 123,
      "revenue_cost_rate_type": "RateForEach",
      "rebill_revenue_rate_value": 123,
      "rebill_percentage": 123,
      "cost_rate_value": 123
    }
  ]
}
'

{
  "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

settlement-id

string

required

Settlement ID

Body

application/json

add_on_charges

(AddOnCharge-Create · object | AddOnCharge-Update-Destroyable · object)[]

AddOnCharge-Create
AddOnCharge-Update-Destroyable

Show child attributes

Response

data

AddOnCharge-Read · object[]

required

Show child attributes

Create an AddOnCharge for a Settlement Update an Agave-Customer

⌘I