Invoice Input

Input representation of the details of the billing schedule.

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