Skip to main content
POST
/
v1
/
companies
/
{company-id}
/
fuel_surcharge_schedules
Create a FuelSurchargeSchedule for a Company
curl --request POST \
  --url https://api.tread-horizon.com/v1/companies/{company-id}/fuel_surcharge_schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "fuel_price_index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "fuel_price_index": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<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

Body

application/json
​
name
string
required
​
fuel_price_index_id
string<uuid>
required
​
surcharge_type
enum<string>
required
Available options:
percentage,
per_unit

Response

Created

​
data
FuelSurchargeSchedule-Read · object
required