Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

name
string
required
Maximum string length: 255
is_active
boolean
progressive_billing_threshold
string<decimal> | null

Cumulative unbilled usage that triggers a mid-agreement invoice. None = only bill on agreement end.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
grace_period_hours
integer

Hours after invoice creation before it may be finalized.

Required range: -2147483648 <= x <= 2147483647
late_ticket_grace_period_hours
integer

Hours a LATE_TICKET draft stays open to batch incoming late tickets before finalization.

Required range: -2147483648 <= x <= 2147483647
progressive_grace_period_hours
integer

Hours a PROGRESSIVE draft stays open before it may be finalized.

Required range: -2147483648 <= x <= 2147483647
payment_due_hours
integer

Number of hours when payment is due after finalizations.

Required range: -2147483648 <= x <= 2147483647
effective_date
string<date> | null

Agreements that ended before this date will not generate invoices. Null means no restriction.

payment_instructions
string | null

HTML rendered in the Payment Instructions section of driver invoice PDFs.

charges
object[]

Response

201 - application/json
id
integer
required
read-only
fleet
integer
required
read-only
name
string
required
Maximum string length: 255
created_at
string<date-time>
required
read-only
is_active
boolean
progressive_billing_threshold
string<decimal> | null

Cumulative unbilled usage that triggers a mid-agreement invoice. None = only bill on agreement end.

Pattern: ^-?\d{0,8}(?:\.\d{0,2})?$
grace_period_hours
integer

Hours after invoice creation before it may be finalized.

Required range: -2147483648 <= x <= 2147483647
late_ticket_grace_period_hours
integer

Hours a LATE_TICKET draft stays open to batch incoming late tickets before finalization.

Required range: -2147483648 <= x <= 2147483647
progressive_grace_period_hours
integer

Hours a PROGRESSIVE draft stays open before it may be finalized.

Required range: -2147483648 <= x <= 2147483647
payment_due_hours
integer

Number of hours when payment is due after finalizations.

Required range: -2147483648 <= x <= 2147483647
effective_date
string<date> | null

Agreements that ended before this date will not generate invoices. Null means no restriction.

payment_instructions
string | null

HTML rendered in the Payment Instructions section of driver invoice PDFs.

charges
object[]