Manage billing scenarios by using the Billing class. You can convert negative invoice lines, create and apply a credit memo to an invoice, generate invoices, and recover billing schedules.
These methods are for Billing. All methods are static.
convertNegativeInvoiceLines(ConvertNegativeInvoiceLinesInput, invoiceId)
Convert a list of invoice lines with a negative amount into a posted credit memo. This conversion is applicable for a single invoice at a time.
createCreditMemos(CreditMemoInputRequest)
Create a credit memo without applying it to an invoice. You can credit the invoice at a later date.
creditInvoice(CreditInvoiceInput, invoiceId)
Create a credit memo and apply it to an invoice. The credit memo can fully or partially credit the invoice.
generateInvoices(inputRequest)
Create an invoice from a billing schedule.
recoverBillingSchedules(inputRequest)
Recover the latest generated invoice associated with the billing schedules in the Error or Processing status.
voidPostedCreditMemo(VoidPostedCreditMemoInput, creditMemoId)
Invoke the Void Posted Credit Memo API by providing a credit memo ID.
Void a posted invoice to rebill the customer, if necessary.
Convert a list of invoice lines with a negative amount into a posted credit memo. This conversion is applicable for a single invoice at a time.
62.0
No
public static ConnectApi.ConvertNegativeInvoiceLinesResult convertNegativeInvoiceLines(ConnectApi.ConvertNegativeInvoiceLinesInputRequest ConvertNegativeInvoiceLinesInput, String invoiceId)
ConvertNegativeInvoiceLinesInput
Type: ConnectApi.ConvertNegativeInvoiceLinesInputRequest
Input parameters to convert a negative invoice line to a credit.
invoiceId
Type: String
ID of the invoice whose negative invoice lines must be converted.
Type: ConnectApi.ConvertNegativeInvoiceLinesResult
You need the Credit Memo Operations User permission set to use this method.
Keep these considerations in mind when you use this method.
Posted status.Create a credit memo without applying it to an invoice. You can credit the invoice at a later date.
62.0
No
public static ConnectApi.RevenueAsyncRepresentation createCreditMemos(ConnectApi.StandaloneCreditMemoInputRequest CreditMemoInputRequest)
CreditMemoInputRequest
Type: ConnectApi.StandaloneCreditMemoInputRequest
Input representation of the details required to create a standalone credit memo.
Type: ConnectApi.RevenueAsyncRepresentation
You need the Credit Memo Operations User permission set to use this method.
Specify the credit memo header information, charge parameters, adjustment parameters, and tax parameters. A credit memo requires at least one credit memo line. The credit memo line can be a charge or an adjustment.
Specify the credit memo lines that you want as lists of charges and adjustments. Each credit memo line must be related to a product.
Create a credit memo and apply it to an invoice. The credit memo can fully or partially credit the invoice.
62.0
No
public static ConnectApi.RevenueAsyncLineLevelOutputResponse creditInvoice(ConnectApi.CreditInvoiceInputRequest CreditInvoiceInput, String invoiceId)
CreditInvoiceInput
Type: ConnectApi.CreditInvoiceInputRequest
Input representation of the details of the request to create a credit memo.
invoiceId
Type: String
ID of the invoice to be credited partially or fully. The status of the invoice must be Posted.
Type: ConnectApi.RevenueAsyncLineLevelOutputResponse
Use this method to adjust an outstanding invoice balance or rectify errors in an invoice. Pass a list of invoice lines to credit. Keep these considerations in mind when you use this API.
This method creates and posts a credit memo. The credit memo has one credit memo line for each invoice line passed in the API request. The invoice’s balance is then reduced by a value equal to the credit memo’s balance. This API modifies the balance of a posted invoice or invoice line based on the specified credit application level for your org. See Apply Credits to Posted Invoices or Invoice Lines.
Create an invoice from a billing schedule.
62.0
No
public static ConnectApi.RevenueAsyncRepresentation generateInvoices(ConnectApi.InvoiceInputRepresentation inputRequest)
inputRequest
Type: ConnectApi.InvoiceInputRepresentation
Input representation of the details of the billing schedule.
Type: ConnectApi.RevenueAsyncRepresentation
You need the Generate Invoices From Billing Schedule API permission set to use this method.
This method creates one billing period item for each unbilled period between the billing schedule’s next billing date and the invoice’s target date. Additionally, one invoice line is created for each billing period item. This method creates up to six billing periods per request.
Recover the latest generated invoice associated with the billing schedules in the Error or Processing status.
62.0
No
public static ConnectApi.BillingScheduleRecoveryResults recoverBillingSchedules(ConnectApi.BillingScheduleRecoveryInputRequest inputRequest)
inputRequest
Type: ConnectApi.BillingScheduleRecoveryInputRequest
Input representation of the details of the billing schedules to recover the associated invoice.
Type: ConnectApi.BillingScheduleRecoveryResults
You need the Manage Errors Using Invoice Error Recovery API permission set to use this method.
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 method to recover the invoice associated with the billing schedules in the Error or Processing status.
Invoke the Void Posted Credit Memo API by providing a credit memo ID.
66.0
No
public static ConnectApi.VoidPostedCreditMemoOutputRepresentation voidPostedCreditMemo(ConnectApi.VoidPostedCreditMemoInputRepresentation VoidPostedCreditMemoInput, String creditMemoId)
VoidPostedCreditMemoInput
Type: ConnectApi.VoidPostedCreditMemoInputRepresentation
Input representation of the details of a credit memo to be voided.
creditMemoId
Type: String
Required. ID of the credit memo record in posted status to be voided.
Type: ConnectApi.VoidPostedCreditMemoOutputRepresentation
Void a posted invoice to rebill the customer, if necessary.
62.0
No
public static ConnectApi.RevenueAsyncRepresentation voidPostedInvoice(String invoiceId)
invoiceId
Type: String
ID of the posted invoice to be voided.
Type: ConnectApi.RevenueAsyncRepresentation
You need the Void a Posted Invoice API permission set to use this method.
This method changes the invoice status from Posted to Void In Progress. The invoice remains in the Void In Progress status until the credit is applied and financial fields are recalculated on the invoice’s related billing period items and billing schedule. The invoice status changes to Voided after all recalculations are completed.
Keep these considerations in mind when you use this method.
Void In Progress status. You also can’t update the invoice fields.Credit Memos
The void process creates a credit memo, which contains one credit memo line for each invoice line, including tax lines. For example, if the invoice line has a balance of US$20, the related credit memo line has a balance of $20. The credit memo’s balance is then allocated to the invoice header’s balance, reducing it to zero. A credit memo invoice application is created to record the details of the void process.
Negative Invoice Lines
If an invoice has negative invoice lines that aren’t converted to a credit memo, you can use this endpoint to void the posted invoice.
j