POST /v1/operations/invoice-collect

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.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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-Id`	String	No	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-version`	String	No	The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: documentDate targetDate If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. See Zuora REST API Versions for more information.
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Idempotency-Key`	String	No	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.
`Zuora-Entity-Ids`	String	No	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 do not need to set this header.
`Zuora-Org-Ids`	String	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`paymentGateway`	String	No	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.
`invoiceNumber`	String	No	The 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 REST API version is 214.0 or earlier) `documentDate` and `targetDate` (if the Zuora REST API version is 215.0 or later available versions)
`documentDate`	String	No	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. This field is in Zuora REST API version control. Supported minor versions are `215.0` and later available versions. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.
`invoiceDate`	String	No	Note: This field has been replaced by the `documentDate` field in Zuora REST API version `215.0` and later available versions. The `invoiceDate` field is only available for backward compatibility. The date that should appear on the invoice being 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 in Zuora REST API version control. Supported minor versions are `214.0` and earlier available versions.
`accountKey`	String	Yes	Customer account ID or account number.
`invoiceTargetDate`	String	No	Note: This field has been replaced by the `targetDate` field in Zuora REST API version `215.0` and later available versions. The `invoiceTargetDate` field is only available for backward compatibility. The date through which to calculate charges on this account if an invoice 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 in Zuora REST API version control. Supported minor versions are `214.0` and earlier available versions.
`targetDate`	String	No	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. Note: The credit memo is only available if you have the Invoice Settlement feature enabled. This field is in Zuora REST API version control. Supported minor versions are `215.0` and later available versions. To use this field in the method, you must set the `zuora-version` parameter to the minor version number in the request header.
`invoiceId`	String	No	The ID 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 REST API version is 214.0 or earlier) `documentDate` and `targetDate` (if the Zuora REST API version is 215.0 or later available versions)

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.