Skip to main content
PATCH
Update an AddOn

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

id
string
required

AddOn ID

Body

application/json
name
string
cost_rate_value
number | null

The cost rate or buy price of the add on.

revenue_rate_value
number

The revenue rate or sell price of the add on.

revenue_cost_rate_type
enum<string>
default:RateForEach
Available options:
RateForEach,
RatePercentOfTotal,
PerLoad,
FuelSurcharge
Example:

"RateForEach"

add_on_types
enum<string>[]
Available options:
driver_pay,
invoicing,
job,
settlement,
driver_day
quantity
number
external_id
string | null
percentage
number
Required range: -100 <= x <= 100
accounting_id
string | null
rate
number
deprecated

Deprecated in favor of revenue_rate_value.

add_on_rate_type
enum<string>
default:RateForEach
deprecated

Deprecated in favor of revenue_cost_rate_type.

Available options:
RateForEach,
RatePercentOfTotal,
PerLoad,
FuelSurcharge
Example:

"RateForEach"

fuel_surcharge_schedule_id
string<uuid> | null
taxable
boolean
default:false

Whether this add-on is eligible for taxation

Response

OK

data
AddOn-Read · object
required