Response Bodies

Learn more about the available response bodies of Billing APIs.

Addresses

Output representation of the details of the addresses that are used for calculating tax.
Address

Output representation of the location code associated with an address.
Batch Invoice Document Generation

Output representation of the request to generate or regenerate the PDF documents for the invoices that are in the Draft or Posted status.
Error Response

Output representation of the error details encountered during the API request.
Error Response for Batch Invoice Document Generation

Output representation of the error details associated with the Batch Invoice Document Generation API.
Batch Invoice Scheduler

Output representation of the details of an invoice scheduler.
Batch Payment Scheduler

Output representation of the details of a payment scheduler.
Billing Checkout

Output representation of the billing checkout transaction result.
Billing Arrangement

Output representation that contains the details of a billing arrangement, including its status, configuration settings, and associated lines.
Billing Arrangement Line

Output representation that contains the details of a specific line item within a billing arrangement, defining how charges are split for an account.
Billing Batch Scheduler

Output representation of the details of a created invoice or payment scheduler.
Billing Schedule Recovery List

Output representation of the recovered details of the billing schedules and associated invoice.
Billing Schedule Recovery

Output representation of the details of the recovered billing schedules.
Composite Collection Plan

Output representation of the results for each collection plan.
Collection Plan

Output representation of the result of a single collection plan creation request.
Collection Plan Error

Output representation of an error that occurred while creating a collection plan.
Context-Aware Billing Schedule

Output representation of the context-aware billing schedule.
Context-Aware Billing Schedule Error

Output representation of the error response related to the generation of the billing schedule.
Convert Negative Invoice Lines

Output representation of the details of the created memo along with the status of the request.
Credit Memo Apply

Output representation of the list of applied credit memo results.
Credit Memo Apply List

Output representation of the list of applied credit memo results.
Credit Memo Post

Output representation of the request to post a credit memo.
Credit Memo Unapply

Output representation of the details of the credit memo invoice application record with the status of the request.
Credit Memo Line Applied

Output representation of the list of applied credit memo line results.
Credit Memo Line Applied Response

Output representation of the list of applied credit memo line results.
Credit Memo Line Unapplied

Output representation of the details of the credit memo line invoice line record with the status of the request.
Document Details

Output representation of the details of the generated document.
Invoice Batch Draft To Posted

Output representation of the batch update details of the invoices from Draft to Posted status.
Invoice Batch Run Recovery

Output representation of the details of the invoice batch run recovery record.
Invoice Ingestion

Output representation of the details of the generated invoices.
Invoice Ingestion Details

Output representation of the details of a generated invoice.
Invoice Ingestion Output Error

Output representation of the details of an invoice generation error.
Invoice Line Preview

Output representation of the invoice line preview result.
Invoice Preview

Output representation of the invoice preview result.
Invoice Preview Result

Output representation of the list of preview invoices that are generated for the billing transaction.
Invoice Recovery

Output representation of the details of the recovered invoice and billing schedules.
Line Item

Output representation of the details of the line item.
On-Demand Document Generation Response

Output representation of the details of the generated document along with error response.
Payment Line Apply

Output representation of the details of the applied payment line. The details include the ID of the payment record and date when the payment line was applied.
Payment Line Unapply

Output representation of the details of the reversed payment line application. The details include the ID of the payment line record and date when the payment line application was reversed.
Payment Scheduler Update

Output representation of the details of the updated payment scheduler. This representation covers the updated status value of the specified payment scheduler.
Posted Invoice List Write-Off

Output representation of the list of invoices that are written off.
Posted Invoice Write-Off

Output representation of the details of a posted invoice that’s written off.
Posted Invoice Write-Off Error

Output representation of the error response that’s associated with a request to write off a posted invoice.
Reference Line Error

Output representation of the details of the line level errors.
Refund Credit Memo

Output representation for the process refund against a credit memo API.
Refund Line Applied Response

Output representation of the details of an applied refund. This representation includes the properties of a refund line, such as the date when the refund is applied against a payment and ID of the refund line record.
Revenue Async Line Level

Output representation of the result of the API request for the async line level operations.
Revenue Async Response

Output representation of the result of the API request with the request identifier.
Rules Application

Output representation of the details of rules application.
Rules Application Error

Output representation of the error details for rules application failure.
Rules Application Summary

Output representation of the summary of the application rule. This includes the number of payments and credit memos for the account, the total number of payments and credit memos that’s applied to invoices, and whether all invoices for an account are considered (true) or not (false).
Send Email Error

Output representation of the error response of the API request to send emails for posted invoices.
Send Email Response

Output representation of the API request to send emails for posted invoices.
Sequence Error

Output representation of the error response that’s associated with a request to create or update a sequence policy, or assign sequences.
Sequence Gap Reconciliation Error

Output representation of the errors encountered during the processing of the API request.
Sequence Gap Reconciliation

Output representation of the details of the sequence gap reconciliation.
Sequence Policy

Output representation that shows the status of the assigned sequence pattern values.
Sequences Assignment

Output representation with the status of the assigned sequence pattern values.
Sequences Assignment Result

Output representation of the details of the assigned sequence values to target objects.
Statement of Account

Output representation of the details of the generated account statement with async tracking details.
Suspend Resume Billing

Output representation of the list of accounts and billing schedule groups, which are suspended or resumed for billing operations.
Suspend Resume Billing Object

Output representation of the details of accounts and billing schedule groups, which are suspended or resumed for billing operations, along with the status of the API request.
Tax Amount Details

Output representation of the details of the tax amount.
Tax Calculation

Output representation of the details of the calculated tax.
Tax Details

Output representation of the tax details for each line item.
Tax Engine Log

Output representation of the logs that the tax engine generates.
Tax Imposition

Output representation of the details of the imposed tax.
Tax Jurisdiction

Output representation of the details of the tax jurisdiction for the tax line.
Void Posted Credit Memo

Output representation of the request to void a posted credit memo.