--- title: "Collect a posted debit memo" method: POST path: "/v1/debit-memos/{debitMemoKey}/collect" tags: ["Debit Memos"] --- # Collect a posted debit memo `POST /v1/debit-memos/{debitMemoKey}/collect` **Note:** This operation is only available if you have [Invoice Settlement](https://docs.zuora.com?resourceId=billing-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](https://docs.zuora.com?resourceId=billing-invoice-settlement-migration-checklist-and-guide) for more information. This API operation provides an easy way to let the client-side to collect an existing posted debit memo. It supports the following steps: 1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos. 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments. 3. Process payment to the posted debit memo if there is an open-balance on it. **Restrictions** Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions: 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected. 2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected. 3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected. 4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected. ## Path parameters - `debitMemoKey` string, required ## Headers - `Idempotency-Key` string - `Accept-Encoding` string - `Content-Encoding` string - `Zuora-Track-Id` string - `Zuora-Entity-Ids` string - `Zuora-Org-Ids` string - `Zuora-Version` string ## Request body - DebitMemoCollectRequest - `applicationOrder` string[] — The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply the debit memo. - `applyCredit` boolean — Whether to automatically apply credit memos or unapplied payments, or both to the debit memo. If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is `false`, no action is taken. - `collect` boolean — Indicates if the current request needs to collect payment or not. - `payment` object — Some detail info that would be used to processed an electronic payment. The info would only effect when `collect` set to `true`. - `gatewayId` string — The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method. If no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used. - `paymentMethodId` string — The unique ID of the payment method that the customer used to make the payment. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs. ## Response `200` OK - DebitMemoCollectResponse - `appliedCreditMemos` DebitMemoCollectResponseAppliedCreditMemos[] — The information about which credit memo applied to the specific debit memo. - `appliedAmount` number, double — The applied amount of the credit memo to the debit memo. - `id` string — The unique ID of the credit memo. - `number` string — The unique identification number of the credit memo. - `unappliedAmount` number, double — The unapplied amount of the credit memo after applied to the debit memo. - `appliedPayments` DebitMemoCollectResponseAppliedPayments[] — The information about which payment applied to the specific debit memo. - `appliedAmount` number, double — The applied amount of the payment to the debit memo. - `id` string — The unique ID of the payment. - `number` string — The unique identification number of the payment. - `unappliedAmount` number, double — The unapplied amount of the payment after applied to the debit memo. - `debitMemo` object — The information about the debit memo that just collected. - `id` string — The unique ID of the debit memo. - `number` string — The unique identification number of the debit memo. - `organizationLabel` string — The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. - `processedPayment` object — The information about the payment that newly processed to the debit memo. - `amount` number, double — The total amount of the payment. - `gatewayId` string — The ID of the gateway instance that processes the payment. - `gatewayResponse` string — The message returned from the payment gateway for the payment. This message is gateway-dependent. - `gatewayResponseCode` string — The code returned from the payment gateway for the payment. This code is gateway-dependent. - `id` string — The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f. - `number` string — The unique identification number of the payment. For example, P-00000001. - `paymentMethodId` string — The unique ID of the payment method that the customer used to make the payment. - `status` 'Processing' | 'Processed' | 'Error' | 'Canceled' — The status of the payment. - `success` boolean — Returns `true` if the request was processed successfully. ## Other responses - `500` — Internal Server Error - `4XX` — Request Errors --- [API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)