Skip to main content
A quote owns its invoices. Before you bind it, you decide how the policy will be invoiced, and the quote keeps that decision: its own invoice settings, and the plan of invoices that binding will create and void. The app’s Billing step and these endpoints read and write the same record, so a quote prepared in one looks the same in the other.

Settings

A quote’s settings are a schedule (how often installments fall due, how many, the first due date, how many days early each is sent, whether to avoid weekend sends, and any down payment), a payee for each policy invoice type, and an endorsement handling. Until you save settings on a quote, it uses your company’s payment defaults, applied to that quote: the first due date counts from the quote’s effective date, which is the policy start date for new business and renewals and the change date for an endorsement, cancellation or reinstatement. The quote’s invoicing shows which applies in settingsSource. Settings you save belong to the quote alone, on every quote type, and they stay when its plan is cleared. Each policy invoice type’s invoices are issued to a payee. A payee chosen in the settings is used. For a type with none chosen, generating takes, in order: the payee of the plan already on the quote; on an endorsement, cancellation or reinstatement, the payee of the policy’s current invoices of that type; then the payee the invoice type is configured with. If none is found, generating refuses and asks you to choose one.

Generating or attaching a plan

There are two ways to put a plan on a quote, and either one replaces the plan already there:
  • Generate. The plan is built from the quote’s settings and its saved fullTermBillingInfo, the way the app’s Generate Invoices builds it, and the settings it used are saved with it.
  • Attach. You write the plan yourself: which existing invoices to void, and which invoices to create. Before it is saved it gets the checks a bind runs, including that the invoices add up to the quote’s billing, line item by line item.
Settings never rewrite a plan: changing them after you attach one leaves it as you wrote it. Clearing the plan leaves the settings, ready for the next generation.

Endorsements, cancellations and reinstatements

A quote that changes an existing policy starts from the policy’s current invoices. Generating applies the settings’ endorsement handling to them: Paid invoices and invoices with payments are never voided. Kept invoices count toward the new billing, so new invoices bill only what is left. When kept paid invoices bill more than the new billing, as on a cancellation of a paid policy, the excess is credited on the same line.

Binding

Binding the quote uses the plan saved on it. The plan is checked again at bind, against the policy’s invoices and the quote’s billing at that moment. If an invoice the plan voids was paid or changed since the plan was saved, or the billing moved, the bind refuses and nothing is committed: generate or attach the plan again. Once the quote is bound or cancelled its invoicing no longer changes (409). A bound quote’s policy holds its invoices, and Update Policy Invoices changes them. These endpoints need policy invoicing enabled for your company; otherwise they return 403 finv2-policy-invoicing-disabled.

Endpoints