Billing Schedule Recovery List (POST)

Recover the latest generated invoice associated with the billing schedules in the Error or Processing status.

Billing schedules include critical details such as the amount to be billed, next billing date, and status. An invoice can be associated with one or more billing schedules. When an invoice is generated or posted, the billing schedules are updated to reflect the accurate state of the invoice. The billing schedules associated with an invoice are marked in the Error status if any of the invoicing processes have errors. Use this API to recover the invoice associated with the billing schedules in the Error or Processing status.

Special Access Rules 

You need the Manage Errors Using Invoice Error Recovery API permission set to use this API.

Resource 

1/commerce/invoicing/billing-schedules/collection/actions/recover

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/commerce/invoicing/billing-schedules/collection/actions/recover

Available Version 

62.0

HTTP Methods 

POST

Request Body for POST 

JSON Example

1{
2    "billingScheduleIds": ["44bDU00000000XXYAY"]
3  }

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
billing​Schedule​IdsString[]IDs of the billing schedules to recover the invoice for. You can recover one billing schedule per API request.Required62.0

Response Body for POST 

Billing Schedule Recovery List