Defer an invoice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_idstringrequired

Request body

Schema: DeferInvoiceRequest

deferred_amount_centsinteger

Amount routed to Deferred Revenue. Defaults to the invoice's revenue (total excluding sales tax); may not exceed it.

unitDeferralUnitEnumDeferralUnitEnum

Denominator unit: months, hours or custom

methodDeferralMethodEnumDeferralMethodEnum

straight_line auto-populates every numerator; custom leaves them for the user and posts nothing until they are filled in.

period_countintegerrequired

Number of monthly recognition periods

total_unitsnumber | string

Denominator quantity (e.g. 400 hours). Defaults to period_count for the months unit.

start_datestring · date

First recognition period (defaults to today's month)

revenue_ledger_namestring

Revenue account the recognition entries credit. Defaults to the account the invoice itself booked revenue to.

periodsarray · DeferralPeriodInput

Optional per-period numerators for a custom schedule. Length must match period_count when supplied.

notesstring

Responses