Working with invoice streams
An invoice stream is a container that manages a set of invoices. It is responsible for scheduling the invoices with a regular cadence.
- For accounts that use policy-level billing, each policy is managed by its own invoice stream.
- For accounts that use account-level billing, policies with the same payment interval are placed on the same invoice stream. For example, if an account had two policies billed weekly and three policies billed monthly, the weekly policies would be on one invoice stream, and the monthly policies would be on another.
Every invoice stream has two fundamental attributes:
- Anchor date – This identifies the starting point for the cadence of invoices.
- Periodicity – This identifies how frequently the cadence occurs.
For example, suppose an invoice stream has an anchor date of May 11th, 2020 and a periodicity of monthly. This invoice stream will schedule its invoices monthly on the 11th of each month starting with May 11th, 2020.
InvoiceStream properties
Invoice streams inherit two values from the parent account:
- Whether the account uses bill date billing or due date billing
- The anchor date of the relevant periodicity
An invoice stream can have values that override the defaults from the parent account. In other words, a given invoice stream can have a bill date/due date billing or anchor date that is different from what is specified at the account level.
The InvoiceStream resource has the following properties:
creationOrder- A value used for automatic stream selection when there is more than one stream that an invoice item could be assigned to.currency- The currency of the invoices in the stream.overridingBillDateOrDueDateBilling- The override value for the invoice stream's bill date/due date setting.overridingFirstAnchorDate- The override value for the invoice stream's anchor date.periodicity- The periodicity of the invoice stream.policy- The policy associated with the invoice stream. This is applicable to invoice streams for policy-level billing only.