Skip to main content
PUT

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId
string<uuid>
required

Company identifier

quoteId
string<uuid>
required

Quote identifier

Body

application/json

A fully explicit, detached policy-invoice batch. Existing invoices not named in voidInvoices are kept. The complete kept-plus-created set must conserve each line item of the policy's stated billing. With invoicing enabled, a line item a kept invoice carries but billing omits conserves at 0: a create may credit it on the same line with a negative amount.

incurredDate
string<date>
required

Explicit recognition date for non-scheduled creates. It is never inferred from a transaction effective date or the server clock.

voidInvoices
object[]
required
creates
object[]
required

Response

The quote's invoicing, with the attached plan.

A quote's invoicing: the settings it generates invoices from and the plan saved on it. Binding the quote uses them. Every quote invoicing endpoint returns this.

quoteId
string<uuid>
required
settings
object
required

The settings a quote generates its invoices from. A PUT sends every field and replaces them all. A GET returns the same shape, so you can change a field of a GET's settings and send the object back.

settingsSource
enum<string>
required

Where settings come from. quote once the quote has settings of its own: saved with Replace Quote Invoice Settings, kept by Generate Quote Invoices, or saved in the app's Billing step. A plan attached without settings counts too, because its schedule is what settings shows. company-defaults while nothing on the quote sets them: settings are the company's payment defaults, applied to this quote.

Available options:
quote,
company-defaults
plan
object
required

The plan saved on the quote, or null when it holds none.