Skip to main content
POST
Create an AddOnCharge for an Invoice (company-scoped)

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

invoice-id
string
required

Invoice ID

Body

application/json
name
string
required
percentage
number
Required range: -100 <= x <= 100
quantity
number
rate
number
deprecated

Deprecated in favor of revenue_rate_value.

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

"RateForEach"

add_on_id
string<uuid> | null
invoice_id
string<uuid>
deprecated
external_id
string | null
accounting_id
string | null
load_id
string<uuid>
revenue_rate_value
number

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"

rebill_revenue_rate_value
number | null
rebill_percentage
number | null
cost_rate_value
number | null

The cost rate or buy price of the add on.

Response

Created

data
AddOnCharge-Read · object
required