Apply a payment

Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Applies an unapplied payment to invoices and debit memos.

When you apply a payment, the total number of invoice items and debit memo items that the payment will apply to must be less than or equal to 15,000.

If the limit is hit, you can follow the instructions:

  • If you want to apply one payment to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request.
  • If you want to apply one payment to a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000.

For more information, see Apply Unapplied Payments to Invoices and Debit Memos.

Request
path Parameters
paymentKey
required
string

The unique ID or number of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1, or P-00000001.

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 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-Ids
string

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

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.

Request Body schema: application/json
required
Array of objects (debitMemos)

Container for debit memos. The maximum number of debit memos is 1,000.

effectiveDate
string <date>

The date when the payment application takes effect, in yyyy-mm-dd format. The effective date must be later than or equal to the maximum effective date of the payment.

Array of objects (invoices)

Container for invoices. The maximum number of invoices is 1,000.

Responses
200
put/v1/payments/{paymentKey}/apply
Request samples
application/json
{
  • "debitMemos": [
    ],
  • "effectiveDate": "2017-03-01",
  • "invoices": [
    ]
}
Response samples
application/json
{
  • "accountId": "4028905f5a87c0ff015a87d25ae90025",
  • "accountNumber": "A00000001",
  • "amount": 44.1,
  • "appliedAmount": 44.1,
  • "authTransactionId": null,
  • "bankIdentificationNumber": null,
  • "cancelledOn": null,
  • "comment": "normal payment",
  • "createdById": "402881e522cf4f9b0122cf5d82860002",
  • "createdDate": "2017-03-01 11:30:37",
  • "creditBalanceAmount": 0,
  • "currency": "USD",
  • "effectiveDate": "2017-03-01",
  • "financeInformation": {
    },
  • "gatewayId": null,
  • "gatewayOrderId": null,
  • "gatewayReconciliationReason": null,
  • "gatewayReconciliationStatus": null,
  • "gatewayResponse": null,
  • "gatewayResponseCode": null,
  • "gatewayState": "NotSubmitted",
  • "id": "4028905f5a87c0ff015a87eb6b75007f",
  • "markedForSubmissionOn": null,
  • "number": "P-00000001",
  • "paymentGatewayNumber": "PG-00000001",
  • "paymentMethodId": "402881e522cf4f9b0122cf5dc4020045",
  • "paymentMethodSnapshotId": null,
  • "payoutId": null,
  • "referenceId": null,
  • "refundAmount": 0,
  • "secondPaymentReferenceId": null,
  • "settledOn": null,
  • "softDescriptor": null,
  • "softDescriptorPhone": null,
  • "status": "Processed",
  • "submittedOn": null,
  • "success": true,
  • "type": "External",
  • "unappliedAmount": 0,
  • "updatedById": "402881e522cf4f9b0122cf5d82860002",
  • "updatedDate": "2017-03-01 13:56:15"
}