Skip to main content
POST
Create a Rate

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"

Body

application/json

Base model for Rate creation. Do not use this directly, instead use the submodels.

name
string
required
type
enum<string>
required
Available options:
RatePerHour,
RatePerDay,
RatePerLoad,
RatePerTon,
RatePerTonne,
RatePerYard,
RatePerBushel,
RateCommission,
RateFlatCommission,
RateFlatRate
Example:

"RatePerHour"

company_id
string<uuid>
required
time_rate
number
required
Required range: x >= 0
time_minimum_minutes
integer
required
Required range: x >= 0
time_increment_minutes
integer
required
Required range: x >= 0
account_id
string<uuid>
account_type
enum<string>
Available options:
customer,
vendor
Example:

"customer"

primary
boolean
fuel_surcharge_enabled
boolean
project_ids
string<uuid>[]
service_ids
string<uuid>[]
equipment_ids
string<uuid>[]
owner_type
enum<string>
default:driver
Available options:
customer,
vendor,
driver
Example:

"driver"

driver_id
string<uuid>
add_on_ids
string<uuid>[]
service_class_id
string<uuid> | null
equipment_type_id
string<uuid> | null

Response

Created

data
RateTime-Read · object
required

Base model for Rates. Do not use this directly, instead use the submodels.