Skip to main content
PATCH
Update AutoAddOnAssignment

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<uuid>
required

AutoAddOnAssignment ID

Body

application/json
name
string
quantity
number
rate
number
deprecated

Deprecated in favor of revenue_rate_value.

percentage
number
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"

external_id
string | null
accounting_id
string | null
add_on_types
enum<string>[]
Available options:
driver_pay,
invoicing,
job,
settlement,
driver_day
total_installments
integer
Required range: x >= 0
revenue_rate_value
string

The cost rate or buy price of the add on.

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

"RateForEach"

cost_rate_value
string | null

The cost rate or buy price of the add on.

Response

OK

data
AutoAddOnAssignment-Read · object
required

Note:

  • add_on_id is deprecated