Invoice Creation (POST)

Create an invoice for an account, order, or a list of billing schedules.

This API request creates billing period items for the matching billing schedules. The billing period items are created for the period between the next charge date of the billing schedule and the specified target date. Invoice lines are created by processing these billing period items. These invoice lines are then grouped into invoices based on the defined grouping criteria on the billing schedule.

This API also applies any available credits on an account to settle an invoice and to reduce it’s balance. To apply available credits, ensure the Apply Credits to Posted Invoices setting from Billing Settings is turned on.

Special Access Rules 

You need the Generate Invoices From Billing Schedule API, Billing Operations User, or Billing Customer Service permission set to use this API.

Resource 

1/commerce/invoicing/invoices/collection/actions/generate

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/invoicing/invoices/collection/actions/generate

Available Version 

62.0

HTTP Methods 

POST

Request Body for POST 

Note: The billing​TransactionId property takes precedence over the accountId property followed by the billing​ScheduleIds property when values for these properties are specified in the input request.

JSON Example

1{
2  "accountId": "001SG00000mYtRWYA0",
3  "action": "Posted",
4  "billingScheduleIds": [
5    "44bSG000000CVeMYAW"
6  ],
7  "billingTransactionId": "801SG00000mYtaXYAS",
8  "correlationId": null,
9  "invoiceDate": "2024-01-12",
10  "targetDate": "2024-01-12"
11}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
accountIdStringID of the account record to create the invoices for.Required if the billing​ScheduleIds or billing​TransactionId property isn’t specified.63.0
actionString Required62.0
billing​ScheduleIdsString[]List of billing schedule IDs that’s used to create the invoices. You can specify a maximum of 200 billing schedules.Required if the accountId or billing​TransactionId property isn’t specified.62.0
billing​TransactionIdStringID of the billing transaction record, which is the order ID, to create the invoices for.Required if the accountId or billing​ScheduleIds property isn’t specified.63.0
correlation​IdStringProperty that’s tagged against the published InvoiceProcessedEvent event, if specified.Optional62.0
invoice​DateStringStamping date of the invoice in ISO 8601 format.Required62.0
target​DateStringDate in ISO 8601 format used to decide the billing periods that are included to create invoices.Required62.0

Supported values:

  • Draft
  • Posted

Response Body for POST 

Revenue Async Response