Skip to navigation
Billing DocumentsOperations

Invoice and collect

View as Markdown

Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted.

You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer’s default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify.

  • To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the invoiceId field empty.

  • To collect payment on an existing invoice, specify the invoice ID.

The operation is atomic; if any part is unsuccessful, the entire operation is rolled back.

When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples.

  • Orbital: 05 Do Not Honor; 14 Invalid Credit Card Number
  • Vantiv: 301 Invalid Account Number; 304 Lost/Stolen Card
  • CyberSource2: 202 Expired card; 231 Invalid account number

For more reason code information, see the corresponding payment gateway documentation.

Notes

Timeouts may occur when using this method on an account that has an extremely high number of subscriptions.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional<=255 characters
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. With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.
Accept-EncodingstringOptional

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-EncodingstringOptional

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Zuora-Track-IdstringOptional<=64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora 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 ("), and quote (').

Zuora-Entity-IdsstringOptional

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-IdsstringOptional

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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user’s accessible orgs.

Zuora-VersionstringOptional

The minor API version.

For a list of available minor versions, see API upgrades.

Request

This endpoint expects an object.
accountKeystringRequired
Customer account ID or account number.
documentDatedateOptional

The date that should appear on the invoice and credit memo being generated, in yyyy-mm-dd format. If this field is omitted and invoiceId is not specified, the current date is used by default.

Note: The credit memo is only available if you have the Invoice Settlement feature enabled.

Note: This field is available only if you are on the latest Zuora API version, or you set the Zuora-Version request header to 215.0 or a later available version.

invoiceIdstringOptional

The ID or number of an existing invoice for which to collect payment using the account’s default payment method. If this value is specified, no new invoice is generated, and the following fields are ignored:

  • invoiceDate and invoiceTargetDate (if the Zuora minor API version is 214.0 or earlier)
  • documentDate and targetDate (if the Zuora minor API version is 215.0 or a later available version)
paymentGatewaystringOptional
The name of the gateway that will be used for the payment. Must be a valid gateway name and the gateway must support the specific payment method. If a value is not specified, the default gateway on the Account will be used.
targetDatedateOptional

The date through which to calculate charges on this account if an invoice or a credit memo is generated, in yyyy-mm-dd format. If this field is omitted and invoiceId is not specified, the current date is used by default. This field is available only if you are on the latest Zuora API version, or you set the Zuora-Version request header to 215.0 or a later available version.

Note: The credit memo is only available if you have the Invoice Settlement feature enabled.

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-IdstringOptional
The Zuora internal identifier of the API call. You cannot control the value of this header.
Zuora-Track-IdstringOptional
A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.
Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Response

OK
amountCollecteddoubleOptional
Payment amount applied.
creditMemoslist of objectsOptional
Information on one or more credit memos associated with this operation.
invoiceslist of objectsOptional
Information on one or more invoices associated with this operation.
paymentIdstringOptional
Payment ID.
successbooleanOptional

Returns true if the request was processed successfully.

Errors

4XX
Client Request Error
500
Internal Server Error