POST /v1/debitmemos

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.

Creates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models.

When debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.

You can create a debit memo only if you have the user permission. See Billing Roles for more information.

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. See Minor Version for information about REST API version control. This header affects the availability of the following request fields: `charges` > `amount` `charges` > `memoItemAmount` `charges` > `chargeId` `charges` > `productRatePlanChargeId` `charges` > `comment` `charges` > `description` `customRates` > `currency` `customRates` > `customFxRate` `customRates` > `rateDate`
`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
`effectiveDate`	String	No	The date when the debit memo takes effect.
`IntegrationStatus__NS`	String	No	Status of the debit memo's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`accountId`	String	No	The ID of the account associated with the debit memo. Note: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.
`IntegrationId__NS`	String	No	ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`reasonCode`	String	No	A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.
`currency`	String	No	The code of a currency as defined in Billing Settings through the Zuora UI. If you do not specify a currency during debit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. Note: This field is available only if you have the Multiple Currencies feature enabled.
`accountNumber`	String	No	The number of the account associated with the debit memo. Note: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account.
`comment`	String	No	Comments about the debit memo.
`dueDate`	String	No	The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.
`SyncDate__NS`	String	No	Date when the debit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`autoPay`	Boolean	No	Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run.
`charges[]`	Array	No	Container for product rate plan charges. The maximum number of items is 1,000.
`charges[].comment`	String	No	Comments about the product rate plan charge. Note: This field is not available if you set the `zuora-version` request header to `257.0` or before.
`charges[].excludeItemBillingFromRevenueAccounting`	Boolean	No	The flag to exclude the debit memo item from revenue accounting. Note: This field is only available if you have the Billing - Revenue Integration feature enabled. Default value: false
`charges[].serviceEndDate`	String	No	The service end date of the debit memo item. If not specified, the effective end date of the corresponding product rate plan will be used.
`charges[].description`	String	No	The description of the product rate plan charge. Note: This field is only available if you set the `zuora-version` request header to `257.0` or later available versions.
`charges[].memoItemAmount`	Number	No	The amount of the debit memo item. Note: This field is not available if you set the `zuora-version` request header to `224.0` or later available versions.
`charges[].amount`	Number	No	The amount of the debit memo item. Note: This field is only available if you set the `zuora-version` request header to `224.0` or later available versions.
`charges[].quantity`	Number	No	The number of units for the debit memo item.
`charges[].serviceStartDate`	String	No	The service start date of the debit memo item. If not specified, the effective start date of the corresponding product rate plan will be used.
`charges[].productRatePlanChargeId`	String	Yes	The ID of the product rate plan charge that the debit memo is created from. Note: This field is only available if you set the `zuora-version` request header to `257.0` or later available versions.
`charges[].financeInformation`	Object	No	Container for the finance information related to the product rate plan charge associated with the debit memo.
`charges[].financeInformation.recognizedRevenueAccountingCode`	String	No	The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
`charges[].financeInformation.revenueRecognitionRuleName`	String	No	The name of the revenue recognition rule governing the revenue schedule.
`charges[].financeInformation.deferredRevenueAccountingCode`	String	No	The accounting code for the deferred revenue, such as Monthly Recurring Liability.
`charges[].chargeId`	String	Yes	The ID of the product rate plan charge that the debit memo is created from. Note: This field is not available if you set the `zuora-version` request header to `257.0` or later available versions.
`customRates[]`	Array	No	It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both). Note: The API custom rate feature is permission controlled.
`customRates[].rateDate`	String	No	The date on which a particular currency rate is fixed or obtained on. Note: This field is only available if you set the `zuora-version` request header to `224.0` or later available versions.
`customRates[].currency`	String	Yes	The currency code for either Reporting or Home currency. Note: This field is only available if you set the `zuora-version` request header to `224.0` or later available versions.
`customRates[].customFxRate`	Number	Yes	The Custom FX conversion rate between home currency and transactional currency items. Note: This field is only available if you set the `zuora-version` request header to `224.0` or later available versions.
`autoPost`	Boolean	No	Whether to automatically post the debit memo after it is created. Setting this field to `true`, you do not need to separately call the Post a debit memo operation to post the debit memo. Default value: false

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.