Billing: Invoice Generate
The invoice generate task generates an invoice for a specified account. If Invoice Settlement is enabled, credit memos can be generated as well.
This task is equivalent to the single account mode of the bill run task.
You need to have an upstream task to retrieve the accounts that you want to generate billing document for. If you need to generate billing document for multiple accounts, you need to add an iterate task and place the generate invoice task after the For Each condition.
Task Settings
Setup
- Account.Id - Manually enter an ID or select a data field to identify the account.
- Call Type - The API call type to generate invoices. If you need to generate multiple invoices, select REST. The SOAP API call does not support generating more than one invoice.
- Invoice Date - The date when the billing document is generated. This field is specific to the SOAP API call.
- Target Date - The date that is used to determine what charges will be invoiced. All charges that are to be billed on this date or prior will be included in this invoice.
- Effective Date - The date on which to generate the invoices. This field is specific to the REST API call.
- Subscription IDs - The IDs of the subscriptions that you want to create the billing documents for. Each value must be the ID of the latest version of an active subscription. This field is specific to the REST API call.
- Auto Post - Whether to automatically post the invoices after the draft invoices are generated. If an error occurs during posting invoices, the draft invoices are not generated too. This field is specific to the REST API call.
- Auto Renew - Whether to automatically renew the subscriptions. This field is specific to the REST API call.
- Include OneTime Charges - Select to include one-time charges in the invoice.
- Include Recurring Charges - Select to include recurring charges in the invoice.
- Include Usage Charges - Select to include usage charges in the invoice.
Validation
- Ignore Blank Invoices - Enabled by default. APIs for generating invoices will throw errors if an account has no charges to be invoiced. If this option is enabled, the task will ignore such errors.