Note: The API operations in this section have been deprecated.
Billing Documents represent your customer's invoices, credit memos and debit memos. Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain invoice items, and proration adjustments that may be caused by changes to a subscription. If your invoice is configured to be charged automatically, Zuora automatically finalizes your invoice and attempts payment otherwise Zuora will email the invoice to your customer and await payment. Any customer credit memos may be applied before determining the amount due for the invoice (i.e., the amount that will be charged).
Retrieves the billing document with the given ID.
Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `balance`, `description`, `state`, `tax`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `name`, `quantity`, `recognized_revenue_account`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_inclusive`, `unit_amount`Allows you to specify which fields are returned in the response.
Accepted values
`custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`Allows you to expand responses by including related object information in a single call. See the Expand responses section of the Quickstart API Tutorials for detailed instructions.
A case-sensitive filter on the list. See the Filter lists section of the Quickstart API Tutorial for detailed instructions.
Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the "Retrieve a billing document" operation, you can use the filter[] parameter on the related objects such as filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63
A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), or quote (').
Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.
An entity ID. If you have Multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity or you do not have Multi-entity enabled, you do not need to set this header.
Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see Idempotent Requests.
Include a accept-encoding: gzip header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see Request and Response Compression.
Include a content-encoding: gzip header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see Request and Response Compression.
Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.
The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.
If the header is not set, the operation is performed in scope of the user's accessible orgs.
- https://rest.test.zuora.com/v2https://rest.test.zuora.com/v2/billing_documents/{billing_document_id}
- US API Sandbox Cloud 1https://rest.sandbox.na.zuora.com/v2/billing_documents/{billing_document_id}
- US API Sandbox Cloud 2https://rest.apisandbox.zuora.com/v2/billing_documents/{billing_document_id}
- US Production Cloud 1https://rest.na.zuora.com/v2/billing_documents/{billing_document_id}
- US Production Cloud 2https://rest.zuora.com/v2/billing_documents/{billing_document_id}
- https://rest.test.eu.zuora.com/v2https://rest.test.eu.zuora.com/v2/billing_documents/{billing_document_id}
- EU API Sandboxhttps://rest.sandbox.eu.zuora.com/v2/billing_documents/{billing_document_id}
- EU Productionhttps://rest.eu.zuora.com/v2/billing_documents/{billing_document_id}
- https://rest.test.ap.zuora.com/v2https://rest.test.ap.zuora.com/v2/billing_documents/{billing_document_id}
- APAC Productionhttps://rest.ap.zuora.com/v2/billing_documents/{billing_document_id}
curl -i -X GET \
'https://rest.test.zuora.com/v2/billing_documents/{billing_document_id}?fields%5B%5D=id%2Ccreated_time&billing_document.fields%5B%5D=id%2Ccreated_time&billing_document_items.fields%5B%5D=id%2Ccreated_time&taxation_items.fields%5B%5D=id%2Ccreated_time&expand%5B%5D=string&filter%5B%5D=string&page_size=1' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'accept-encoding: string' \
-H 'async: false' \
-H 'content-encoding: string' \
-H 'idempotency-key: string' \
-H 'zuora-entity-ids: string' \
-H 'zuora-org-ids: string' \
-H 'zuora-track-id: string'Default Response
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The date and time when the object was last updated in ISO 8601 UTC format.
The date and time when the object was created in ISO 8601 UTC format.
Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.
An arbitrary string associated with the object. Often useful for displaying to users.
The date on which payment for the billing document is due.
Reason for issuing this billing document. This field is applicable only if the type field is set to credit_memo or debit_memo.
The identifier of the invoice billing document from which this credit memo or debit memo billing document is created. This field is applicable only if the type field is set to credit_memo or debit_memo.
Indicates whether to exclude this credit memo billing document from the rule of automatically applying it to invoices. This field is applicable only if the type field is set to credit_memo.
Indicates whether the billing document is automatically picked up for processing in the corresponding payment run.
The type of billing document. Can be one of the credit memo, debit memo, or invoice.
A human-readable identifier for the billing document; may be user-supplied.
Whether payment was successfully collected for this invoice. An invoice can be paid with a payment or a credit memo.
{ "id": "8ad093f27f54fa8d017f6b191ff02543", "updated_by_id": "2c92c0946a6dffc0016a7faab604299b", "updated_time": "2022-09-07T14:16:31-07:00", "created_by_id": "2c92c0946a6dffc0016a7faab604299b", "created_time": "2022-03-08T11:54:43-08:00", "custom_fields": { "field__c": "custom field value" }, "account_id": "2c92c0f96abc17de016abd62bd0c5854", "description": "comments", "due_date": "2020-02-01", "document_date": "2020-02-01", "type": "invoice", "billing_document_number": "INV00006606", "amount_refunded": 0, "state_transitions": { "posted_at": "2022-03-08T11:54:43-08:00" }, "posted_by_id": "2c92c0946a6dffc0016a7faab604299b", "state": "open", "total": 300, "subtotal": 300, "tax": 0, "remaining_balance": 225, "amount_paid": 75, "paid": false, "past_due": true }