Paths below are under
/api/v1/companies/{companyId}.
Before you start
- The quote’s submission and its exposures exist. Reference them by
id. - Your API key’s role holds
quote.create,quote.edit,quote.rateandquote.bind, andquote.viewto read the quote back. Withform.createandform.edittoo, the create adds the quote’s recommended quote forms and the bind its policy forms (see Recommended forms on quote create). - You know the name of the rating workflow to run. A rate that names none, or
an unknown one, returns
400listing your company’s workflows.
Choose the path
At a company that invoices, a quote states the pricing stack layer it is meant to bind at. Complete and Bind refuse a quote whose bind would land anywhere else. The app calls the layers Financials Setups, and the path follows from the setup:
Pricing Only (
pricing) follows the Invoicing Off row for a quote whose
billing calculation states no billing. No Pricing (base) skips rating.
The examples use one quote: a year from 2026-01-01, rated at 1,200.00, whose
billing states one line, Premium on the Policy Invoice type. The names are
an example company’s; use your own, which
Export Financials Configuration
lists. Your company’s configuration decides which other fields the quote needs.
Full Billing, completed here
Four requests.-
Create the quote with its setup.
pricingSetupholds the quote’s intended layer and, when they differ from your company’s payment defaults, its invoice settings, shaped as Replace Quote Invoice Settings takes them.The response isPOST /api/v1/companies/{companyId}/entities/quote201with the quote’sid. The quote and its setup are saved together: a refused setting creates nothing.pricingSetupis not a field, so entity reads never return it. Send anIdempotency-Keyto make a retry safe. -
Rate the quote and save the rating.
The rating is saved as the app saves it: the quote statesPOST /api/v1/companies/{companyId}/quotes/{quoteId}/rate
fullTermPricingInfo, its billing calculation statesfullTermBillingInfo(onePremiumline of 1,200.00), and the run becomes the quote’s current rating. The response’sdatais the rated quote. A rating that fails is still a200, withdiagnosticsand nodata, and saves nothing. -
Complete the quote, generating its invoices.
Complete generates the quote’s invoice plan from its settings, as Generate Quote Invoices does, and saves it: fourPATCH /api/v1/companies/{companyId}/entities/quote/{quoteId}
Premiuminvoices of30000cents, due 2026-01-01, 2026-04-01, 2026-07-01 and 2026-10-01. It then completes the quote, checking it as its bind will. If either is refused, neither is saved. To review the invoices before you bind,GET /api/v1/companies/{companyId}/quotes/{quoteId}/invoicingshows them. -
Bind the invoices the quote offers.
POST /api/v1/companies/{companyId}/quotes/{quoteId}/bind
120000 cents in all.
Full Billing, quoted in your own app
Three requests, when your own system presents the quote and its terms: the quote stays in progress, and the bind generates its invoices.- Create the quote with its setup, as above.
- Rate it and save the rating, as above.
-
Bind it, generating the invoices from its settings.
POST /api/v1/companies/{companyId}/quotes/{quoteId}/bind
Invoicing Off
Four requests, and no invoices.-
Create the quote meant to bind at Invoicing Off:
POST /api/v1/companies/{companyId}/entities/quote
- Rate it and save the rating, as above.
-
Complete it:
{ "quoteStatus": "complete" }. -
Bind it naming no invoices:
{}.
A company that does not invoice
A company that does not invoice has no layers to choose. Create the quote withoutpricingSetup (sending it returns
403 finv2-policy-invoicing-disabled), rate it and save the rating, complete
it, and bind it naming no invoices.
When a step is refused
A refusal saves nothing, and its message names the one request that fixes it, with your ids. The ones this journey meets most:
Check Bind Conditions
runs the bind’s checks without binding, if you want to know before you send it.
Related
- Rating: stateless rates, and what a saved rating writes
- Quote Invoicing Overview: invoice settings, plans, Complete and the bind’s
invoices - The pricing stack: the layers and the intended-layer check
- Invoicing a policy: the other ways to put invoices on a policy
