swagger: '2.0'
info:
  version: '2023-12-15'
  title: API Reference Accounting Codes Debit Memos API
  description: "\n\n# Introduction\n\nWelcome to the REST API reference for the Zuora Billing, Payments, and Central Platform!\n\nTo learn about the common use cases of Zuora REST APIs, check out the [REST API Tutorials](/rest-api/api-guides/overview/).\n\nIn addition to Zuora API Reference, we also provide API references for other Zuora products:\n\n  * [Revenue API Reference](/api-references/revenue/overview/)\n  * [Collections API Reference](/api-references/collections/overview/)\n    \nThe Zuora REST API provides a broad set of operations and resources that:\n\n  * Enable Web Storefront integration from your website.\n  * Support self-service subscriber sign-ups and account management.\n  * Process revenue schedules through custom revenue rule models.\n  * Enable manipulation of most objects in the Zuora Billing Object Model.\n\nWant to share your opinion on how our API works for you? <a href=\"https://community.zuora.com/t5/Developers/API-Feedback-Form/gpm-p/21399\" target=\"_blank\">Tell us how you feel </a>about using our API and what we can do to make it better.\n\nSome of our older APIs are no longer recommended but still available, not affecting any existing integration. To find related API documentation, see [Older API Reference](/api-references/older-api/overview/).\n\n\n## Access to the API\n\nIf you have a Zuora tenant, you can access the Zuora REST API via one of the following endpoints:\n\n| Tenant              | Base URL for REST Endpoints |\n|-------------------------|-------------------------|\n|US Cloud 1 Production | https://rest.na.zuora.com  |\n|US Cloud 1 API Sandbox |  https://rest.sandbox.na.zuora.com |\n|US Cloud 2 Production | https://rest.zuora.com |\n|US Cloud 2 API Sandbox | https://rest.apisandbox.zuora.com|\n|US Central Sandbox | https://rest.test.zuora.com |  \n|US Performance Test | https://rest.pt1.zuora.com |\n|US Production Copy | Submit a request at <a href=\"http://support.zuora.com/\" target=\"_blank\">Zuora Global Support</a> to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. See [REST endpoint base URL of Production Copy (Service) Environment for existing and new customers](https://community.zuora.com/t5/API/REST-endpoint-base-URL-of-Production-Copy-Service-Environment/td-p/29611) for more information. |\n|EU Production | https://rest.eu.zuora.com |\n|EU API Sandbox | https://rest.sandbox.eu.zuora.com |\n|EU Central Sandbox | https://rest.test.eu.zuora.com |\n\nThe Production endpoint provides access to your live user data. Sandbox tenants are a good place to test code without affecting real-world data. If you would like Zuora to provision a Sandbox tenant for you, contact your Zuora representative for assistance.\n\n\nIf you do not have a Zuora tenant, go to <a href=\"https://www.zuora.com/resource/zuora-test-drive\" target=\"_blank\">https://www.zuora.com/resource/zuora-test-drive</a> and sign up for a Production Test Drive tenant. The tenant comes with seed data, including a sample product catalog.\n\n\n# Error Handling\n\nIf a request to Zuora Billing REST API with an endpoint starting with `/v1` (except [Actions](/v1-api-reference/api/Actions) and CRUD operations) fails, the response will contain an eight-digit error code with a corresponding error message to indicate the details of the error.\n\nThe following code snippet is a sample error response that contains an error code and message pair:\n\n```\n {\n   \"success\": false,\n   \"processId\": \"CBCFED6580B4E076\",\n   \"reasons\":  [\n     {\n      \"code\": 53100320,\n      \"message\": \"'termType' value should be one of: TERMED, EVERGREEN\"\n     }\n    ]\n }\n```\nThe `success` field indicates whether the API request has succeeded. The `processId` field is a Zuora internal ID that you can provide to Zuora Global Support for troubleshooting purposes.\n\nThe `reasons` field contains the actual error code and message pair. The error code begins with `5` or `6` means that you encountered a certain issue that is specific to a REST API resource in Zuora Billing, Payments, and Central Platform. For example, `53100320` indicates that an invalid value is specified for the `termType` field of the `subscription` object.\n\nThe error code beginning with `9` usually indicates that an authentication-related issue occurred, and it can also indicate other unexpected errors depending on different cases. For example, `90000011` indicates that an invalid credential is provided in the request header. \n\nWhen troubleshooting the error, you can divide the error code into two components: REST API resource code and error category code. See the following Zuora error code sample:\n\n<a href=\"/ images/ZuoraErrorCode.jpeg\" target=\"_blank\"><img src=\"/ images/ZuoraErrorCode.jpeg\" alt=\"Zuora Error Code Sample\"></a>\n\n\n**Note:** Zuora determines resource codes based on the request payload. Therefore, if GET and DELETE requests that do not contain payloads fail, you will get `500000` as the resource code, which indicates an unknown object and an unknown field. \nThe error category code of these requests is valid and follows the rules described in the [Error Category Codes](/api-references/api/overview/#section/Error-Handling/Error-Category-Codes) section. \nIn such case, you can refer to the returned error message to troubleshoot.\n\n\n## REST API Resource Codes\n\nThe 6-digit resource code indicates the REST API resource, typically a field of a Zuora object, on which the issue occurs. In the preceding example, `531003` refers to the `termType` field of the `subscription` object. \n\nThe value range for all REST API resource codes is from `500000` to `679999`. See <a href=\"https://knowledgecenter.zuora.com/Central_Platform/API/AA_REST_API/Resource_Codes\" target=\"_blank\">Resource Codes</a> in the Knowledge Center for a full list of resource codes.\n\n## Error Category Codes\n\nThe 2-digit error category code identifies the type of error, for example, resource not found or missing required field. \n\nThe following table describes all error categories and the corresponding resolution:\n\n| Code    | Error category              | Description    | Resolution    |\n|:--------|:--------|:--------|:--------|\n| 10      | Permission or access denied | The request cannot be processed because a certain tenant or user permission is missing. | Check the missing tenant or user permission in the response message and contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> for enablement. |\n| 11      | Authentication failed       | Authentication fails due to invalid API authentication credentials. | Ensure that a valid API credential is specified. |\n| 20      | Invalid format or value     | The request cannot be processed due to an invalid field format or value. | Check the invalid field in the error message, and ensure that the format and value of all fields you passed in are valid. |\n| 21      | Unknown field in request    | The request cannot be processed because an unknown field exists in the request body. | Check the unknown field name in the response message, and ensure that you do not include any unknown field in the request body. |\n| 22      | Missing required field      | The request cannot be processed because a required field in the request body is missing. | Check the missing field name in the response message, and ensure that you include all required fields in the request body. |\n| 23      | Missing required parameter  | The request cannot be processed because a required query parameter is missing. | Check the missing parameter name in the response message, and ensure that you include the parameter in the query. |\n| 30      | Rule restriction            | The request cannot be processed due to the violation of a Zuora business rule. | Check the response message and ensure that the API request meets the specified business rules. |\n| 40      | Not found                   | The specified resource cannot be found. | Check the response message and ensure that the specified resource exists in your Zuora tenant. |\n| 45      | Unsupported request         | The requested endpoint does not support the specified HTTP method. | Check your request and ensure that the endpoint and method matches. |\n| 50      | Locking contention          | This request cannot be processed because the objects this request is trying to modify are being modified by another API request, UI operation, or batch job process. | <p>Resubmit the request first to have another try.</p> <p>If this error still occurs, contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> with the returned `Zuora-Request-Id` value in the response header for assistance.</p> |\n| 60      | Internal error              | The server encounters an internal error. | Contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> with the returned `Zuora-Request-Id` value in the response header for assistance. |\n| 61      | Temporary error             | A temporary error occurs during request processing, for example, a database communication error. | <p>Resubmit the request first to have another try.</p> <p>If this error still occurs, contact <a href=\"https://support.zuora.com\" target=\"_blank\">Zuora Global Support</a> with the returned `Zuora-Request-Id` value in the response header for assistance. </p>|\n| 70      | Request exceeded limit      | The total number of concurrent requests exceeds the limit allowed by the system. | <p>Resubmit the request after the number of seconds specified by the `Retry-After` value in the response header.</p> <p>Check [Concurrent request limits](/rest-api/general-concepts/rate-concurrency-limits/) for details about Zuora’s concurrent request limit policy.</p> |\n| 90      | Malformed request           | The request cannot be processed due to JSON syntax errors. | Check the syntax error in the JSON request body and ensure that the request is in the correct JSON format. |\n| 99      | Integration error           | The server encounters an error when communicating with an external system, for example, payment gateway, tax engine provider. | Check the response message and take action accordingly. |\n\n\n# API Versions\n\nThe Zuora REST API are version controlled. Versioning ensures that Zuora REST API changes are backward compatible. Zuora uses a major and minor version nomenclature to manage changes. By specifying a version in a REST request, you can get expected responses regardless of future changes to the API.\n\n## Major Version\n\nThe major version number of the REST API appears in the REST URL. In this API reference, only the **v1** major version is available. For example, `POST https://rest.zuora.com/v1/subscriptions`.\n\n## Minor Version\n\nZuora uses minor versions for the REST API to control small changes. For example, a field in a REST method is deprecated and a new field is used to replace it. \n\nSome fields in the REST methods are supported as of minor versions. If a field is not noted with a minor version, this field is available for all minor versions. If a field is noted with a minor version, this field is in version control. You must specify the supported minor version in the request header to process without an error. \n\nIf a field is in version control, it is either with a minimum minor version or a maximum minor version, or both of them. You can only use this field with the minor version between the minimum and the maximum minor versions. For example, the `invoiceCollect` field in the POST Subscription method is in version control and its maximum minor version is 189.0. You can only use this field with the minor version 189.0 or earlier.\n\nIf you specify a version number in the request header that is not supported, Zuora will use the minimum minor version of the REST API. In our REST API documentation, if a field or feature requires a minor version number, we note that in the field description.\n\nYou only need to specify the version number when you use the fields require a minor version. To specify the minor version, set the `zuora-version` parameter to the minor version number in the request header for the request call. For example, the `collect` field is in 196.0 minor version. If you want to use this field for the POST Subscription method, set the  `zuora-version` parameter to `196.0` in the request header. The `zuora-version` parameter is case sensitive.\n\nFor all the REST API fields, by default, if the minor version is not specified in the request header, Zuora will use the minimum minor version of the REST API to avoid breaking your integration. \n\n### Minor Version History\n\nThe supported minor versions are not consecutive. \nYou can use the following versions to override the default version (`186.0`):\n  - 187.0\n  - 188.0\n  - 189.0\n  - 196.0\n  - 206.0\n  - 207.0\n  - 211.0\n  - 214.0\n  - 215.0\n  - 216.0\n  - 223.0\n  - 224.0\n  - 230.0\n  - 239.0\n  - 256.0\n  - 257.0\n  - 309.0\n  - 314.0\n  - 315.0\n  - 329.0\n  - 330.0\n  - 336.0\n  - 337.0\n  - 338.0\n  - 341.0\n\nIf you set the `zuora-version` header to a version excluded from the preceding list, the corresponding API request is processed as you use the default version, `186.0`.\n\nThe following table lists the supported versions and the fields that have a Zuora REST API minor version.\n\n| Fields         | Minor Version      | REST Methods    | Description |\n|:--------|:--------|:--------|:--------|\n| invoiceCollect | 189.0 and earlier  | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice and collects a payment for a subscription. |\n| collect        | 196.0 and later    | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Collects an automatic payment for a subscription. |\n| invoice | 196.0 and 207.0| [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice for a subscription. |\n| invoiceTargetDate | 206.0 and earlier  | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 207.0 and earlier  | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 207.0 and later | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\") |Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| targetDate | 211.0 and later | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Date through which charges are calculated on the invoice, as `yyyy-mm-dd`. |\n| includeExisting DraftInvoiceItems | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| includeExisting DraftDocItems | 207.0 and later  | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | Specifies whether to include draft invoice items in subscription previews. Specify it to be `true` (default) to include draft invoice items in the preview result. Specify it to be `false` to excludes draft invoice items in the preview result. |\n| previewType | 206.0 and earlier| [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `InvoiceItem`(default), `ChargeMetrics`, and `InvoiceItemChargeMetrics`. |\n| previewType | 207.0 and later  | [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") | The type of preview you will receive. The possible values are `LegalDoc`(default), `ChargeMetrics`, and `LegalDocChargeMetrics`. |\n| runBilling  | 211.0 and later  | [Create Subscription](/v1-api-reference/api/subscriptions/post_subscription \"Create Subscription\"); [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\"); [Renew Subscription](/v1-api-reference/api/subscriptions/put_renewsubscription \"Renew Subscription\"); [Cancel Subscription](/v1-api-reference/api/subscriptions/put_cancelsubscription \"Cancel Subscription\"); [Suspend Subscription](/v1-api-reference/api/subscriptions/put_suspendsubscription/ \"Suspend Subscription\"); [Resume Subscription](/v1-api-reference/api/subscriptions/put_resumesubscription/ \"Resume Subscription\"); [Create Account](/v1-api-reference/api/accounts/post_account \"Create Account\")|Generates an invoice or credit memo for a subscription. **Note:** Credit memos are only available if you have the Invoice Settlement feature enabled. |\n| invoiceDate | 214.0 and earlier  | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice being generated, as `yyyy-mm-dd`. |\n| invoiceTargetDate | 214.0 and earlier  | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice is generated, as `yyyy-mm-dd`. |\n| documentDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date that should appear on the invoice and credit memo being generated, as `yyyy-mm-dd`. |\n| targetDate | 215.0 and later | [Invoice and Collect](/api-references/api/operation/POST_TransactionInvoicePayment \"Invoice and Collect\") |Date through which to calculate charges on this account if an invoice or a credit memo is generated, as `yyyy-mm-dd`. |\n| memoItemAmount | 223.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| amount | 224.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | Amount of the memo item. |\n| subscriptionNumbers | 222.4 and earlier | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers of the subscriptions in an order. |\n| subscriptions | 223.0 and later | [Create order](/api-references/api/operation/POST_Order \"Create order\") | Container for the subscription numbers and statuses in an order. |\n| creditTaxItems | 238.0 and earlier | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\") | Container for the taxation items of the credit memo item. |\n| taxItems | 238.0 and earlier | [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the debit memo item. |\n| taxationItems | 239.0 and later | [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Container for the taxation items of the memo item. |\n| chargeId | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| productRatePlanChargeId | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\") | ID of the product rate plan charge that the memo is created from. |\n| comment | 256.0 and earlier | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Comments about the product rate plan charge, invoice item, or memo item. |\n| description | 257.0 and later | [Create credit memo from charge](/api-references/api/operation/POST_CreditMemoFromPrpc \"Create credit memo from charge\"); [Create debit memo from charge](/api-references/api/operation/POST_DebitMemoFromPrpc \"Create debit memo from charge\"); [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice \"Create credit memo from invoice\"); [Create debit memo from invoice](/api-references/api/operation/POST_DebitMemoFromInvoice \"Create debit memo from invoice\"); [Get credit memo items](/api-references/api/operation/GET_CreditMemoItems \"Get credit memo items\"); [Get credit memo item](/api-references/api/operation/GET_CreditMemoItem \"Get credit memo item\"); [Get debit memo items](/api-references/api/operation/GET_DebitMemoItems \"Get debit memo items\"); [Get debit memo item](/api-references/api/operation/GET_DebitMemoItem \"Get debit memo item\") | Description of the the product rate plan charge, invoice item, or memo item. |\n| taxationItems | 309.0 and later | [Preview an order](/api-references/api/operation/POST_PreviewOrder \"Preview an order\") | List of taxation items for an invoice item or a credit memo item. |\n| batch | 309.0 and earlier | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. |      \n| batches | 314.0 and later | [Create a billing preview run](/api-references/api/operation/POST_BillingPreviewRun \"Create a billing preview run\") | The customer batches to include in the billing preview run. |\n| taxationItems | 315.0 and later | [Preview a subscription](/api-references/api/operation/POST_PreviewSubscription \"Preview a subscription\"); [Update a subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update a subscription\")| List of taxation items for an invoice item or a credit memo item. |\n| billingDocument | 330.0 and later | [Create a payment schedule](/api-references/api/operation/POST_PaymentSchedule \"Create a payment schedule\"); [Create multiple payment schedules at once](/api-references/api/operation/POST_PaymentSchedules \"Create multiple payment schedules at once\")| The billing document with which the payment schedule item is associated. |\n| paymentId | 336.0 and earlier | [Add payment schedule items to a custom payment schedule](/api-references/api/operation/POST_AddItemsToCustomPaymentSchedule/ \"Add payment schedule items to a custom payment schedule\"); [Update a payment schedule](/api-references/api/operation/PUT_PaymentSchedule/ \"Update a payment schedule\"); [Update a payment schedule item](/api-references/api/operation/PUT_PaymentScheduleItem/ \"Update a payment schedule item\"); [Preview the result of payment schedule update](/api-references/api/operation/PUT_PaymentScheduleUpdatePreview/ \"Preview the result of payment schedule update\"); [Retrieve a payment schedule](/api-references/api/operation/GET_PaymentSchedule/ \"Retrieve a payment schedule\"); [Retrieve a payment schedule item](/api-references/api/operation/GET_PaymentScheduleItem/ \"Retrieve a payment schedule item\"); [List payment schedules by customer account](/api-references/api/operation/GET_PaymentSchedules/ \"List payment schedules by customer account\"); [Cancel a payment schedule](/api-references/api/operation/PUT_CancelPaymentSchedule/ \"Cancel a payment schedule\"); [Cancel a payment schedule item](/api-references/api/operation/PUT_CancelPaymentScheduleItem/ \"Cancel a payment schedule item\");[Skip a payment schedule item](/api-references/api/operation/PUT_SkipPaymentScheduleItem/ \"Skip a payment schedule item\");[Retry failed payment schedule items](/api-references/api/operation/POST_RetryPaymentScheduleItem/ \"Retry failed payment schedule items\") | ID of the payment to be linked to the payment schedule item.\n\n\n#### Version 207.0 and Later\n\nThe response structure of the [Preview Subscription](/api-references/api/operation/POST_PreviewSubscription) and [Update Subscription](/v1-api-reference/api/subscriptions/put_subscription \"Update Subscription\") methods are changed. The following invoice related response fields are moved to the invoice container:\n\n  * amount\n  * amountWithoutTax\n  * taxAmount\n  * invoiceItems\n  * targetDate\n  * chargeMetrics\n\n\n# API Names for Zuora Objects\n\nFor information about the Zuora business object model, see [Zuora Business Object Model](/rest-api/general-concepts/object-model/).\n\nYou can use the [Describe](/api-references/api/operation/GET_Describe) operation to list the fields of each Zuora object that is available in your tenant. When you call the operation, you must specify the API name of the Zuora object.\n\nThe following table provides the API name of each Zuora object:\n\n| Object                                        | API Name                                   |\n|-----------------------------------------------|--------------------------------------------|\n| Account                                       | `Account`                                  |\n| Accounting Code                               | `AccountingCode`                           |\n| Accounting Period                             | `AccountingPeriod`                         |\n| Amendment                                     | `Amendment`                                |\n| Application Group                             | `ApplicationGroup`                         |\n| Billing Run                                   | <p>`BillingRun` - API name used  in the [Describe](/api-references/api/operation/GET_Describe) operation, Export ZOQL queries, and Data Query.</p> <p>`BillRun` - API name used in the [Actions](/v1-api-reference/api/Actions). See the CRUD oprations of [Bill Run](/v1-api-reference/api/Bill-Run) for more information about the `BillRun` object. `BillingRun` and `BillRun` have different fields. |                     \n| Billing Preview Run                           | `BillingPreviewRun`                        |                     \n| Configuration Templates                       | `ConfigurationTemplates`                   |\n| Contact                                       | `Contact`                                  |\n| Contact Snapshot                              | `ContactSnapshot`                          |\n| Credit Balance Adjustment                     | `CreditBalanceAdjustment`                  |\n| Credit Memo                                   | `CreditMemo`                               |\n| Credit Memo Application                       | `CreditMemoApplication`                    |\n| Credit Memo Application Item                  | `CreditMemoApplicationItem`                |\n| Credit Memo Item                              | `CreditMemoItem`                           |\n| Credit Memo Part                              | `CreditMemoPart`                           |\n| Credit Memo Part Item                         | `CreditMemoPartItem`                       |\n| Credit Taxation Item                          | `CreditTaxationItem`                       |\n| Custom Exchange Rate                          | `FXCustomRate`                             |\n| Debit Memo                                    | `DebitMemo`                                |\n| Debit Memo Item                               | `DebitMemoItem`                            |\n| Debit Taxation Item                           | `DebitTaxationItem`                        |\n| Discount Applied Metrics                      | `DiscountAppliedMetrics`                   |\n| Entity                                        | `Tenant`                                   |\n| Fulfillment                                   | `Fulfillment`                              |\n| Feature                                       | `Feature`                                  |\n| Gateway Reconciliation Event                  | `PaymentGatewayReconciliationEventLog`     |\n| Gateway Reconciliation Job                    | `PaymentReconciliationJob`                 |\n| Gateway Reconciliation Log                    | `PaymentReconciliationLog`                 |\n| Invoice                                       | `Invoice`                                  |\n| Invoice Adjustment                            | `InvoiceAdjustment`                        |\n| Invoice Item                                  | `InvoiceItem`                              |\n| Invoice Item Adjustment                       | `InvoiceItemAdjustment`                    |\n| Invoice Payment                               | `InvoicePayment`                           |\n| Invoice Schedule                              | `InvoiceSchedule`                          |\n| Invoice Schedule Item                         | `InvoiceScheduleItem`                      |\n| Journal Entry                                 | `JournalEntry`                             |\n| Journal Entry Item                            | `JournalEntryItem`                         |\n| Journal Run                                   | `JournalRun`                               |\n| Notification History - Callout                | `CalloutHistory`                           |\n| Notification History - Email                  | `EmailHistory`                             |\n| Offer                                         | `Offer`                                    |\n| Order                                         | `Order`                                    |\n| Order Action                                  | `OrderAction`                              |\n| Order ELP                                     | `OrderElp`                                 |\n| Order Line Items                              | `OrderLineItems`                           |    \n| Order Item                                    | `OrderItem`                                |\n| Order MRR                                     | `OrderMrr`                                 |\n| Order Quantity                                | `OrderQuantity`                            |\n| Order TCB                                     | `OrderTcb`                                 |\n| Order TCV                                     | `OrderTcv`                                 |\n| Payment                                       | `Payment`                                  |\n| Payment Application                           | `PaymentApplication`                       |\n| Payment Application Item                      | `PaymentApplicationItem`                   |\n| Payment Method                                | `PaymentMethod`                            |\n| Payment Method Snapshot                       | `PaymentMethodSnapshot`                    |\n| Payment Method Transaction Log                | `PaymentMethodTransactionLog`              |\n| Payment Method Update                        | `UpdaterDetail`                             |\n| Payment Part                                  | `PaymentPart`                              |\n| Payment Part Item                             | `PaymentPartItem`                          |\n| Payment Run                                   | `PaymentRun`                               |\n| Payment Transaction Log                       | `PaymentTransactionLog`                    |\n| Price Book Item                               | `PriceBookItem`                            |\n| Processed Usage                               | `ProcessedUsage`                           |\n| Product                                       | `Product`                                  |\n| Product Charge Definition                     | `ProductChargeDefinition`                  |    \n| Product Feature                               | `ProductFeature`                           |\n| Product Rate Plan                             | `ProductRatePlan`                          |\n| Product Rate Plan Definition                  | `ProductRatePlanDefinition`                |    \n| Product Rate Plan Charge                      | `ProductRatePlanCharge`                    |\n| Product Rate Plan Charge Tier                 | `ProductRatePlanChargeTier`                |\n| Rate Plan                                     | `RatePlan`                                 |\n| Rate Plan Charge                              | `RatePlanCharge`                           |\n| Rate Plan Charge Tier                         | `RatePlanChargeTier`                       |\n| Refund                                        | `Refund`                                   |\n| Refund Application                            | `RefundApplication`                        |\n| Refund Application Item                       | `RefundApplicationItem`                    |\n| Refund Invoice Payment                        | `RefundInvoicePayment`                     |\n| Refund Part                                   | `RefundPart`                               |\n| Refund Part Item                              | `RefundPartItem`                           |\n| Refund Transaction Log                        | `RefundTransactionLog`                     |\n| Revenue Charge Summary                        | `RevenueChargeSummary`                     |\n| Revenue Charge Summary Item                   | `RevenueChargeSummaryItem`                 |\n| Revenue Event                                 | `RevenueEvent`                             |\n| Revenue Event Credit Memo Item                | `RevenueEventCreditMemoItem`               |\n| Revenue Event Debit Memo Item                 | `RevenueEventDebitMemoItem`                |\n| Revenue Event Invoice Item                    | `RevenueEventInvoiceItem`                  |\n| Revenue Event Invoice Item Adjustment         | `RevenueEventInvoiceItemAdjustment`        |\n| Revenue Event Item                            | `RevenueEventItem`                         |\n| Revenue Event Item Credit Memo Item           | `RevenueEventItemCreditMemoItem`           |\n| Revenue Event Item Debit Memo Item            | `RevenueEventItemDebitMemoItem`            |\n| Revenue Event Item Invoice Item               | `RevenueEventItemInvoiceItem`              |\n| Revenue Event Item Invoice Item Adjustment    | `RevenueEventItemInvoiceItemAdjustment`    |\n| Revenue Event Type                            | `RevenueEventType`                         |\n| Revenue Schedule                              | `RevenueSchedule`                          |\n| Revenue Schedule Credit Memo Item             | `RevenueScheduleCreditMemoItem`            |\n| Revenue Schedule Debit Memo Item              | `RevenueScheduleDebitMemoItem`             |\n| Revenue Schedule Invoice Item                 | `RevenueScheduleInvoiceItem`               |\n| Revenue Schedule Invoice Item Adjustment      | `RevenueScheduleInvoiceItemAdjustment`     |\n| Revenue Schedule Item                         | `RevenueScheduleItem`                      |\n| Revenue Schedule Item Credit Memo Item        | `RevenueScheduleItemCreditMemoItem`        |\n| Revenue Schedule Item Debit Memo Item         | `RevenueScheduleItemDebitMemoItem`         |\n| Revenue Schedule Item Invoice Item            | `RevenueScheduleItemInvoiceItem`           |\n| Revenue Schedule Item Invoice Item Adjustment | `RevenueScheduleItemInvoiceItemAdjustment` |\n| Subscription                                  | `Subscription`                             |\n| Subscription Product Feature                  | `SubscriptionProductFeature`               |\n| Taxable Item Snapshot                         | `TaxableItemSnapshot`                      |\n| Taxation Item                                 | `TaxationItem`                             |\n| Updater Batch                                 | `UpdaterBatch`                             |\n| Usage                                         | `Usage`                                    |\n"
  contact:
    email: docs@zuora.com
host: rest.zuora.com
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Debit Memos
  description: 'Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo.


    For more information about debit memos, see <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos" target="_blank">Credit and debit memos</a>.

    '
paths:
  /v1/debitmemos:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates 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.\n\nWhen 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.\n\nYou can create a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Create a debit memo from a charge
      operationId: POST_DebitMemoFromPrpc
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018712e8ed250a5b
              number: DM00000001
              accountId: 4028ab1f87121698018712e8e8fe0a4a
              accountNumber: AN_1679649466484
              debitMemoDate: '2023-03-24'
              currency: USD
              targetDate: null
              dueDate: '2023-04-23'
              postedOn: null
              postedById: null
              status: Draft
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: test
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-24 14:47:47'
              createdById: ee47f07f310c4bbeb436bb9ec0e0e627
              updatedDate: '2023-03-24 14:47:47'
              updatedById: ee47f07f310c4bbeb436bb9ec0e0e627
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: null
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "\nThe minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following request fields:\n* `charges` > `amount`\n* `charges` > `memoItemAmount`\n* `charges` > `chargeId`\n* `charges` > `productRatePlanChargeId`       \n* `charges` > `comment`\n* `charges` > `description`\n* `customRates` > `currency`\n* `customRates` > `customFxRate` \n* `customRates` > `rateDate`\n"
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/DebitMemoFromChargeType'
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nUpdates the due date for multiple debit memos in one single request. \n\nThis API operation will be deprecated. You can use the [Update debit memos](/v1-api-reference/api/debit-memos/put_updatedebitmemos) instead, which provides more flexible functionality.\n"
      summary: Update due dates for debit memos
      operationId: PUT_UpdateDebitMemosDueDates
      tags:
      - Debit Memos
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PUTBatchDebitMemosRequest'
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              success: true
          schema:
            $ref: '#/definitions/CommonResponseType'
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves the information about all debit memos associated with all customer accounts.\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/debitmemos?status=Posted\n\n- /v1/debitmemos?referredInvoiceId=null&status=Draft\n\n- /v1/debitmemos?status=Posted&type=External&sort=+number\n"
      summary: List debit memos
      operationId: GET_DebitMemos
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              debitmemos:
              - id: 402890555a87d7f5015a892f2ba10057
                number: DM00000006
                accountId: 402890555a7e9791015a7f15fe44001c
                accountNumber: AN_1679649466484
                debitMemoDate: '2017-10-17'
                targetDate: null
                dueDate: '2017-11-16'
                postedOn: null
                postedById: null
                status: Draft
                sourceType: Standalone
                amount: 50
                taxAmount: 0
                totalTaxExemptAmount: 0
                balance: 50
                beAppliedAmount: 0
                autoPay: true
                comment: the comment
                referredInvoiceId: null
                transferredToAccounting: 'No'
                reasonCode: Correcting invoice error
                createdDate: '2017-03-01 17:24:14'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 17:24:14'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: 402890555a87d7f5015a892f2c5c0060
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
              - id: 402890555a87d7f5015a89251edc0045
                number: DM00000003
                accountId: 402890555a7d4022015a7dabf5f60088
                accountNumber: AN_1679649466488
                debitMemoDate: '2017-11-30'
                targetDate: null
                dueDate: '2017-12-30'
                postedOn: null
                postedById: null
                status: Draft
                sourceType: Standalone
                amount: 0.01
                taxAmount: 0.01
                totalTaxExemptAmount: 0
                balance: 0.01
                beAppliedAmount: 0
                autoPay: true
                comment: the comment
                referredInvoiceId: 402890555a7d4022015a7dadb3b300a4
                transferredToAccounting: 'No'
                reasonCode: Charge Dispute
                createdDate: '2017-03-01 17:13:15'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 17:13:15'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: null
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
              - id: 402890555a87d7f5015a8919e4fe002e
                number: DM00000002
                accountId: 402890555a7d4022015a7dabf5f60088
                accountNumber: AN_1679649466488
                debitMemoDate: '2017-03-01'
                targetDate: null
                dueDate: '2017-03-31'
                postedOn: null
                postedById: null
                status: Draft
                sourceType: Standalone
                amount: 9
                taxAmount: 8
                totalTaxExemptAmount: 0
                balance: 9
                beAppliedAmount: 0
                autoPay: true
                comment: ''
                referredInvoiceId: 402890555a7d4022015a7dadb3b300a4
                referredCreditMemoId: null
                transferredToAccounting: 'No'
                reasonCode: Correcting invoice error
                createdDate: '2017-03-01 17:01:00'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 17:01:00'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: 402890555a87d7f5015a8919e95d003a
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
              - id: 402890555a7e9791015a87b082940067
                number: DM00000001
                accountId: 402890555a7e9791015a7f15fe44001c
                accountNumber: AN_1679649466684
                debitMemoDate: '2017-03-01'
                targetDate: null
                dueDate: '2017-03-31'
                postedOn: null
                postedById: null
                status: Draft
                sourceType: Standalone
                amount: 8.02
                taxAmount: 0.02
                totalTaxExemptAmount: 0
                balance: 8.02
                beAppliedAmount: 0
                autoPay: true
                comment: ''
                referredInvoiceId: 402890555a7e9791015a7f1756aa0035
                referredCreditMemoId: null
                transferredToAccounting: 'No'
                reasonCode: Correcting invoice error
                createdDate: '2017-03-01 10:26:16'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:45:03'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: 402890555a7e9791015a87b083f00072
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoCollectionType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - name: accountId
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `accountId` field.

          '
      - name: accountNumber
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `accountNumber` field.

          '
      - name: amount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `amount` field.

          '
      - name: balance
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `balance` field.

          '
      - name: beAppliedAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `beAppliedAmount` field.

          '
      - name: createdById
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `createdById` field.

          '
      - name: createdDate
        in: query
        type: string
        format: date-time
        required: false
        description: 'This parameter filters the response based on the `createdDate` field.

          '
      - name: currency
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `currency` field.

          '
      - name: debitMemoDate
        in: query
        type: string
        format: date
        required: false
        description: 'This parameter filters the response based on the `debitMemoDate` field.

          '
      - name: dueDate
        in: query
        type: string
        format: date
        required: false
        description: 'This parameter filters the response based on the `dueDate` field.

          '
      - name: number
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `number` field.

          '
      - name: referredInvoiceId
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `referredInvoiceId` field.

          '
      - name: status
        in: query
        type: string
        enum:
        - Draft
        - Posted
        - Canceled
        - Error
        - PendingForTax
        - Generating
        - CancelInProgress
        required: false
        description: 'This parameter filters the response based on the `status` field.

          '
      - name: targetDate
        in: query
        type: string
        format: date
        required: false
        description: 'This parameter filters the response based on the `targetDate` field.

          '
      - name: taxAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `taxAmount` field.

          '
      - name: totalTaxExemptAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `totalTaxExemptAmount` field.

          '
      - name: updatedById
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `updatedById` field.

          '
      - name: updatedDate
        in: query
        type: string
        format: date-time
        required: false
        description: 'This parameter filters the response based on the `updatedDate` field.

          '
      - name: sort
        in: query
        type: string
        required: false
        description: "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*  \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n  - The `-` operator indicates an ascending order.\n  - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by debit memo number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n  - number\n  - accountId\n  - debitMemoDate\n  - targetDate\n  - dueDate\n  - amount\n  - taxAmount\n  - totalTaxExemptAmount\n  - balance\n  - beAppliedAmount\n  - referredInvoiceId\n  - createdDate\n  - createdById\n  - updatedDate\n  - updatedById\n  \nExamples:\n\n- /v1/debitmemos?sort=+number\n\n- /v1/debitmemos?status=Processed&sort=-number,+amount\n"
  /v1/debitmemos/bulk:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. \n\n- If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices.\n- If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges.\n\nThe debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully.\n\nYou can create  debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Create debit memos
      operationId: POST_CreateDebitMemos
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              success: true
              memos:
              - id: 4028ab1f87121698018712ff1b0633e2
                number: DM00000001
                accountId: 4028ab1f87121698018712fef63e33cb
                accountNumber: AN_Test11679650911374
                debitMemoDate: '2023-03-24'
                currency: USD
                targetDate: null
                dueDate: '2023-03-24'
                postedOn: null
                postedById: null
                status: Draft
                amount: 100.0
                taxAmount: 0.0
                totalTaxExemptAmount: 0.0
                balance: 100.0
                beAppliedAmount: 0.0
                autoPay: true
                comment: This is a comment
                referredInvoiceId: null
                transferredToAccounting: 'No'
                reasonCode: Correcting invoice error
                createdDate: '2023-03-24 15:12:01'
                createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b
                updatedDate: '2023-03-24 15:12:01'
                updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b
                cancelledOn: null
                cancelledById: null
                referredCreditMemoId: null
                latestPDFFileId: null
                taxStatus: Complete
                sourceType: Standalone
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
                organizationLabel: MS US
                success: true
              - success: false
                processId: 0356073CB721291A
                reasons:
                - code: 50000040
                  message: Cannot find a Invoice instance with id test.
                objectIndex: 1
          schema:
            $ref: '#/definitions/BulkDebitMemosResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: '

          The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control.

          '
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/POSTBulkDebitMemosRequestType'
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nUpdates the basic and finance information about multiple debit memos.  You can update a maximum of 50 credit memos in one single request.\n  \nThe credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully.\n\nCurrently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.\n\nIf the amount of a memo item is updated, the tax will be recalculated in the following conditions:\n  - The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n  - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nYou can update debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Update debit memos
      operationId: PUT_UpdateDebitMemos
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              success: true
              memos:
              - id: 4028ab1f8712169801872685a5f46605
                number: DM00000001
                accountId: 4028ab1f87121698018726851cc765ee
                accountNumber: AN_Test11679978470016
                debitMemoDate: '2023-03-27'
                currency: USD
                targetDate: null
                dueDate: '2023-03-27'
                postedOn: null
                postedById: null
                status: Draft
                amount: 100.0
                taxAmount: 0.0
                totalTaxExemptAmount: 0.0
                balance: 100.0
                beAppliedAmount: 0.0
                autoPay: true
                comment: new comment123
                referredInvoiceId: null
                transferredToAccounting: 'No'
                reasonCode: Correcting invoice error
                createdDate: '2023-03-28 10:11:45'
                createdById: aff81dbb5dd846868685592640363b5b
                updatedDate: '2023-03-28 10:12:37'
                updatedById: aff81dbb5dd846868685592640363b5b
                cancelledOn: null
                cancelledById: null
                referredCreditMemoId: null
                latestPDFFileId: null
                taxStatus: Complete
                sourceType: Standalone
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                paymentTerm: null
                sequenceSetId: null
                organizationLabel: MS US
                success: true
              - id: 2c98907562482a8301624b9c0a1a0056
                processId: string
                reasons:
                - code: string
                  message: string
                objectIndex: 1
                success: false
          schema:
            $ref: '#/definitions/BulkDebitMemosResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: zuora-version
        in: header
        required: false
        type: string
        description: '

          The minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control.

          '
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PUTBulkDebitMemosRequestType'
  /v1/invoices/{invoiceKey}/debitmemos:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates an ad-hoc debit memo from an invoice.\n\nYou can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Create a debit memo from an invoice
      operationId: POST_DebitMemoFromInvoice
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018712fc005a2ba7
              number: DM00000001
              accountId: 4028ab1f87121698018712fb22312b70
              accountNumber: AN_Test11679650660490
              debitMemoDate: '2023-04-29'
              currency: USD
              targetDate: null
              dueDate: '2023-04-29'
              postedOn: null
              postedById: null
              status: Draft
              amount: 1.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 1.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: the comment
              referredInvoiceId: 4028ab1f87121698018712fb2a3b2b91
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-24 15:08:37'
              createdById: bd19d326bce5465c81df19d3262954c3
              updatedDate: '2023-03-24 15:08:37'
              updatedById: bd19d326bce5465c81df19d3262954c3
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: null
              taxStatus: null
              sourceType: Invoice
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.

          '
        name: invoiceKey
        required: true
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "\nThe minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following request fields:\n* `items` > `comment`\n* `items` > `description`\n"
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/DebitMemoFromInvoiceType'
  /v1/debitmemos/{debitMemoKey}:
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about a specific debit memo.\n"
      summary: Retrieve a debit memo
      operationId: GET_DebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018722ff2bff58b8
              number: DM00000001
              accountId: 4028ab1f87121698018722ff25be58a1
              accountNumber: AN_Test11679919358984
              debitMemoDate: '2023-03-27'
              currency: USD
              targetDate: null
              dueDate: '2023-03-27'
              postedOn: null
              postedById: null
              status: Draft
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: This is a comment
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-27 17:46:01'
              createdById: 0124a1a5d0f84d4288d875fc3b34b1e1
              updatedDate: '2023-03-27 17:46:01'
              updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: null
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        name: debitMemoKey
        required: true
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUpdates the basic and finance information about a debit memo. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. \n\nIf the amount of a memo item is updated, the tax will be recalculated in the following conditions:\n  - The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n  - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nYou can update a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Update a debit memo
      operationId: PUT_DebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018722f8335b3ffb
              number: DM00000001
              accountId: 4028ab1f87121698018722f82d133fe4
              accountNumber: AN_Test11679918902100
              debitMemoDate: '2023-03-27'
              currency: USD
              targetDate: null
              dueDate: '2023-03-27'
              postedOn: null
              postedById: null
              status: Draft
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: new comment123
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-27 17:38:24'
              createdById: 97e12d40f0ab4418a95a93118b272fb6
              updatedDate: '2023-03-27 17:38:27'
              updatedById: 97e12d40f0ab4418a95a93118b272fb6
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: null
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/PUTDebitMemoType'
      - type: string
        in: path
        name: debitMemoKey
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        required: true
    delete:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nDeletes a debit memo. Only debit memos with the Cancelled status can be deleted. \n\nYou can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Delete a debit memo
      operationId: DELETE_DebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              success: true
          schema:
            $ref: '#/definitions/CommonResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.

          '
        name: debitMemoKey
        required: true
  /v1/debitmemos/{debitMemoId}/application-parts:
    get:
      summary: List all application parts of a debit memo
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves information about the payments or credit memos that are applied to a specified debit memo.\n"
      operationId: GET_DebitMemoApplicationParts
      tags:
      - Debit Memos
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: debitMemoId
        in: path
        type: string
        required: true
        description: 'The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.

          '
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: OK
          examples:
            application/json:
              applicationParts:
              - paymentId: null
                creditMemoId: 4028905f60a165a50160b4f632ff023d
                appliedAmount: 22
                createdDate: '2018-01-02 11:42:16'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2018-01-02 11:42:16'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              - paymentId: 4028905f60a165a50160b4f5d5cb0229
                creditMemoId: null
                appliedAmount: 11
                createdDate: '2018-01-02 11:41:38'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2018-01-02 11:41:38'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GetDebitMemoApplicationPartCollectionType'
  /v1/debitmemos/{debitMemoKey}/cancel:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCancels a debit memo. Only debit memos with the Draft status can be cancelled. \n\nYou can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n"
      summary: Cancel a debit memo
      operationId: PUT_CancelDebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018722fd34c6507d
              number: DM00000001
              accountId: 4028ab1f87121698018722fd2e705066
              accountNumber: AN_Test11679919230033
              debitMemoDate: '2023-03-27'
              currency: USD
              targetDate: null
              dueDate: '2023-03-27'
              postedOn: null
              postedById: null
              status: Canceled
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: This is a comment
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-27 17:43:52'
              createdById: bc0211e8ca1440eb97a0aff808f87293
              updatedDate: '2023-03-27 17:43:59'
              updatedById: bc0211e8ca1440eb97a0aff808f87293
              cancelledOn: '2023-03-27 17:43:59'
              cancelledById: bc0211e8ca1440eb97a0aff808f87293
              referredCreditMemoId: null
              latestPDFFileId: 4028ab1f87121698018722fd39fe5087
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.

          '
        name: debitMemoKey
        required: true
  /v1/debitmemos/{debitMemoKey}/collect:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThis API operation provides an easy way to let the client-side to collect an existing posted debit memo.\nIt supports the following steps:\n  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.\n  2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments.\n  3. Process payment to the posted debit memo if there is an open-balance on it.\n\n**Restrictions**\n\nSince 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:\n  1. If the target debit memo gets more than 10 debit memo items, the request will be rejected.\n  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.\n  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.\n  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.\n"
      summary: Collect a posted debit memo
      operationId: POST_DebitMemoCollect
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
          description: ''
          examples:
            application/json:
              debitMemo:
                id: 2c98902f6f1de6d1016f1dfc86aa3c34
                number: DM00003326
              appliedCreditMemos:
              - id: 2c98902f6f1de6d1016f1def4c003bd8
                number: CM00000452
                appliedAmount: 12.8
                unappliedAmount: 0E-9
              - id: 2c98902f6f1de6d1016f1deef1b93bbe
                number: CM00009201
                appliedAmount: 9.99
                unappliedAmount: 0E-9
              appliedPayments:
              - id: 2c98902f6f1de6d1016f1defbf3e3bf5
                number: P-00001602
                appliedAmount: 3.33
                unappliedAmount: 0E-9
              - id: 2c98902f6f1de6d1016f1def887f3bec
                number: P-00001761
                appliedAmount: 1.2
                unappliedAmount: 0E-9
              processedPayment:
                id: 2c98902f6f1de6d1016f1dfc8ad23c68
                number: P-00001803
                status: Processed
                amount: 12.68
                paymentMethodId: 2c98902f6f1de6d1016f1dedba313ba2
                gatewayId: 2c98902f6f1de6d1016f1ded559f3b9d
                gatewayResponse: This transaction has been approved by Test gateway.
                gatewayResponseCode: approve
              success: true
          schema:
            $ref: '#/definitions/DebitMemoCollectResponse'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DebitMemoCollectRequest'
      - name: debitMemoKey
        in: path
        type: string
        required: true
        description: 'The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.

          '
  /v1/debitmemos/{debitMemoKey}/emails:
    post:
      summary: Email a debit memo
      operationId: POST_EmailDebitMemo
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nSends a posted debit memo to the specified email addresses manually.\n\n\n\n### Notes\n  - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.\n\n\n  - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.\n\n\n  - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:\n\n    * The `useEmailTemplateSetting` field is set to `false`.\n    * The email addresses are not specified in the `emailAddresses` field.\n"
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              success: true
          schema:
            $ref: '#/definitions/CommonResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: Request
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PostDebitMemoEmailType'
      - name: debitMemoKey
        in: path
        type: string
        required: true
        description: 'The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
  /v1/debitmemos/{debitMemoKey}/files:
    post:
      summary: Upload a file for a debit memo
      operationId: POST_UploadFileForDebitMemo
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUploads an externally generated PDF file for a debit memo that is in Draft or Posted status.\n\nTo use this operation, you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one debit memo.\n"
      consumes:
      - multipart/form-data
      tags:
      - Debit Memos
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - name: debitMemoKey
        in: path
        description: 'The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001.

          '
        required: true
        type: string
      - name: file
        in: formData
        description: 'The PDF file to upload for the debit memo.

          '
        type: file
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          examples:
            application/json:
              success: true
              fileId: 40289f466463d683016463ef8b7301a3
          description: ''
          schema:
            $ref: '#/definitions/POSTUploadFileResponse'
      x-code-samples:
      - lang: curl
        label: Curl
        source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debitmemos/402890555a87d7f5015a8919e4fe002e/files"

          '
  /v1/debitmemos/{debitMemoKey}/items:
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. \n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n"
      summary: List debit memo items
      operationId: GET_DebitMemoItems
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              items:
              - id: 402890555a87d7f5015a89251ede0046
                amount: 1
                amountWithoutTax: 1
                beAppliedAmount: 0
                balance: 1
                taxMode: TaxExclusive
                sku: SKU-00000002
                skuName: SKU-30
                serviceStartDate: '2017-11-01'
                serviceEndDate: '2017-11-30'
                sourceItemType: InvoiceDetail
                sourceItemId: 402890555a7d4022015a7dadb3b700a6
                appliedToItemId: 402890555a7d4022015a2dadb3b700a6
                excludeItemBillingFromRevenueAccounting: true
                processingType: Charge
                createdDate: '2017-03-01 17:13:15'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 17:13:15'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                comment: This is comment!
                subscriptionId: null
                unitOfMeasure: Each
                unitPrice: 1
                quantity: 1
                soldToContactId: 402881e522cf4f9b0122cf5d82860003
                soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                financeInformation:
                  deferredRevenueAccountingCode: Subscription Revenue
                  deferredRevenueAccountingCodeType: SalesRevenue
                  recognizedRevenueAccountingCode: Subscription Revenue
                  recognizedRevenueAccountingCodeType: SalesRevenue
                taxationItems:
                  data:
                  - id: 402890555a87d7f5015a89251ef10047
                    sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1
                    taxAmount: 0.01
                    balance: 0.01
                    paymentAmount: 0
                    creditAmount: 0
                    name: STATE TAX
                    exemptAmount: 0
                    jurisdiction: CALIFORNIA
                    locationCode: '06'
                    taxCode: ZtaxCode
                    taxCodeDescription: ''
                    taxDate: '2017-11-30'
                    taxRate: 0.0625
                    taxRateDescription: This is tax rate description!
                    taxRateType: Percentage
                    financeInformation:
                      salesTaxPayableAccountingCode: null
                      salesTaxPayableAccountingCodeType: null
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoItemCollectionType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        name: debitMemoKey
        required: true
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "\nThe minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n* `items` > `taxItems`\n* `items` > `taxationItems`\n* `items` > `comment`\n* `items` > `description`\n"
      - name: amount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `amount` field.

          '
      - name: beAppliedAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `beAppliedAmount` field.

          '
      - name: createdById
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `createdById` field.

          '
      - name: createdDate
        in: query
        type: string
        format: date-time
        required: false
        description: 'This parameter filters the response based on the `createdDate` field.

          '
      - name: id
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `id` field.

          '
      - name: serviceEndDate
        in: query
        type: string
        format: date
        required: false
        description: 'This parameter filters the response based on the `serviceEndDate` field.

          '
      - name: serviceStartDate
        in: query
        type: string
        format: date
        required: false
        description: 'This parameter filters the response based on the `serviceStartDate` field.

          '
      - name: sku
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `sku` field.

          '
      - name: skuName
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `skuName` field.

          '
      - name: sourceItemId
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `sourceItemId` field.

          '
      - name: subscriptionId
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `subscriptionId` field.

          '
      - name: updatedById
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `updatedById` field.

          '
      - name: updatedDate
        in: query
        type: string
        format: date-time
        required: false
        description: 'This parameter filters the response based on the `updatedDate` field.

          '
      - name: sort
        in: query
        type: string
        required: false
        description: "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*  \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n  - The `-` operator indicates an ascending order.\n  - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by updated date.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n  - id\n  - amount\n  - beAppliedAmount\n  - sku\n  - skuName\n  - serviceStartDate\n  - serviceEndDate\n  - sourceItemId\n  - createdDate\n  - createdById\n  - updatedDate\n  - updatedById\n  - subscriptionId\n  \nExamples:\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n"
  /v1/debitmemos/{debitMemoKey}/items/{dmitemid}:
    get:
      description: '**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.

        '
      summary: Retrieve a debit memo item
      operationId: GET_DebitMemoItem
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 402890555a87d7f5015a8919e500002f
              amount: 1
              amountWithoutTax: 1
              beAppliedAmount: 0
              balance: 1
              quantity: 1
              taxMode: TaxExclusive
              sku: SKU-00000002
              skuName: ZTax Component
              serviceStartDate: '2017-02-27'
              serviceEndDate: '2017-03-26'
              sourceItemType: InvoiceDetail
              sourceItemId: 402890555a7d4022015a7dadb3b700a6
              appliedToItemId: 402890555a7d4022015a2dadb3b700a6
              processingType: Charge
              createdDate: '2017-03-01 17:01:00'
              excludeItemBillingFromRevenueAccounting: true
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 17:01:00'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              comment: aa
              subscriptionId: null
              unitOfMeasure: Each
              unitPrice: 1
              soldToContactId: 402881e522cf4f9b0122cf5d82860003
              soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
              financeInformation:
                deferredRevenueAccountingCode: Subscription Revenue
                deferredRevenueAccountingCodeType: SalesRevenue
                recognizedRevenueAccountingCode: Subscription Revenue
                recognizedRevenueAccountingCodeType: SalesRevenue
              taxationItems:
                data:
                - id: 402890555a87d7f5015a8919e8450031
                  sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1
                  taxAmount: 5
                  balance: 5
                  paymentAmount: 0
                  creditAmount: 0
                  name: my tax
                  exemptAmount: 0
                  jurisdiction: USA
                  locationCode: ''
                  taxCode: ZtaxCode
                  taxCodeDescription: ''
                  taxDate: '2017-02-27'
                  taxRate: 5
                  taxRateDescription: desc3
                  taxRateType: FlatFee
                  financeInformation:
                    salesTaxPayableAccountingCode: null
                    salesTaxPayableAccountingCodeType: null
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoItemType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](/api-references/api/operation/GET_DebitMemoItems).

          '
        name: dmitemid
        required: true
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        name: debitMemoKey
        required: true
      - name: zuora-version
        in: header
        required: false
        type: string
        description: "\nThe minor version of the Zuora REST API. See [Minor Version](/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. \n\nThis header affects the availability of the following response fields:\n* `taxItems`\n* `taxationItems`\n* `comment`\n* `description`\n"
  /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items:
    get:
      description: '**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Retrieves information about the taxation items of a specific debit memo item.

        '
      summary: List all taxation items of a debit memo item
      operationId: GET_TaxationItemsOfDebitMemoItem
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: "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.        \n"
          description: ''
          examples:
            application/json:
              data:
              - balance: 10
                sourceTaxItemId: null
                paymentAmount: 0
                creditAmount: 0
                financeInformation:
                  salesTaxPayableAccountingCode: null
                  salesTaxPayableAccountingCodeType: null
                id: 402883836904567d01690530df760231
                taxAmount: 10
                name: taxName_0
                exemptAmount: 10
                jurisdiction: Jurisdiction
                locationCode: '8'
                taxCode: taxCode
                taxCodeDescription: taxCodeDescription
                taxDate: '2016-10-10'
                taxRate: 0.1
                taxRateDescription: taxRateDescription
                taxRateType: Percentage
              success: true
          schema:
            $ref: '#/definitions/GETTaxationItemsOfDebitMemoItemType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - type: string
        in: path
        description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](/api-references/api/operation/GET_DebitMemoItems).

          '
        name: dmitemid
        required: true
      - type: string
        in: path
        description: 'The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.

          '
        name: debitMemoId
        required: true
  /v1/debitmemos/{debitMemoKey}/pdfs:
    post:
      summary: Generate a debit memo PDF file
      description: '**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page through the Zuora UI.


        This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled.

        '
      operationId: POST_DebitMemoPDF
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: debitMemoKey
        in: path
        description: 'The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        required: true
        type: string
      tags:
      - Debit Memos
      responses:
        200:
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          examples:
            application/json:
              success: true
          description: ''
          schema:
            $ref: '#/definitions/POSTMemoPdfResponse'
  /v1/debitmemos/{debitMemoKey}/post:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nPosts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n"
      summary: Post a debit memo
      operationId: PUT_PostDebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018722fa8d73483a
              number: DM00000001
              accountId: 4028ab1f87121698018722fa86dc4823
              accountNumber: AN_Test11679919056161
              debitMemoDate: '2023-03-27'
              currency: USD
              targetDate: null
              dueDate: '2023-03-27'
              postedOn: '2023-03-27 17:41:03'
              postedById: e758a64e80f54439913241f9aa537127
              status: Posted
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: This is a comment
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-27 17:40:58'
              createdById: e758a64e80f54439913241f9aa537127
              updatedDate: '2023-03-27 17:41:03'
              updatedById: e758a64e80f54439913241f9aa537127
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: null
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        name: debitMemoKey
        required: true
  /v1/debitmemos/{debitMemoKey}/unpost:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUnposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft.\n\nYou can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n"
      summary: Unpost a debit memo
      operationId: PUT_UnpostDebitMemo
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              id: 4028ab1f87121698018722f3b60c375b
              number: DM00000001
              accountId: 4028ab1f87121698018722f3af193744
              accountNumber: AN_Test11679918607694
              debitMemoDate: '2023-03-27'
              currency: USD
              targetDate: null
              dueDate: '2023-03-27'
              postedOn: null
              postedById: null
              status: Draft
              amount: 100.0
              taxAmount: 0.0
              totalTaxExemptAmount: 0.0
              balance: 100.0
              beAppliedAmount: 0.0
              autoPay: true
              comment: This is a comment
              referredInvoiceId: null
              transferredToAccounting: 'No'
              reasonCode: Correcting invoice error
              createdDate: '2023-03-27 17:33:29'
              createdById: c24f12918d5b45d0b7f9da297b8b7a9d
              updatedDate: '2023-03-27 17:33:42'
              updatedById: c24f12918d5b45d0b7f9da297b8b7a9d
              cancelledOn: null
              cancelledById: null
              referredCreditMemoId: null
              latestPDFFileId: 4028ab1f87121698018722f3bb0b376b
              taxStatus: Complete
              sourceType: Standalone
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              paymentTerm: null
              sequenceSetId: null
              organizationLabel: MS US
              success: true
          schema:
            $ref: '#/definitions/GETDebitMemoType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        name: debitMemoKey
        required: true
  /v1/debitmemos/{debitMemoKey}/taxationitems:
    post:
      description: '**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/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://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Creates taxation items for a debit memo.

        '
      summary: Create taxation items for a debit memo
      operationId: POST_DM_TaxationItems
      tags:
      - Debit Memos
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          description: ''
          examples:
            application/json:
              taxationItems:
              - createdById: 402881e522cf4f9b0122cf5d82860002
                createdDate: '2017-03-01 10:27:20'
                exemptAmount: 0
                id: 402890555a7e9791015a87b17cee0076
                memoItemId: 402890555a7e9791015a87b082980068
                sourceTaxItemId: 402890555a7d4022015a7db254e200c2
                jurisdiction: CALIFORNIA
                locationCode: '06'
                name: STATE TAX
                taxAmount: 0.01
                taxCode: ServiceTaxCode
                taxCodeDescription: This is tax code description!
                taxDate: '2016-06-05'
                taxRate: 0.0625
                taxRateDescription: This is tax rate description!
                taxRateType: Percentage
                updatedById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:27:20'
                financeInformation:
                  onAccountAccountingCode: null
                  onAccountAccountingCodeType: null
                  salesTaxPayableAccountingCode: Check
                  salesTaxPayableAccountingCodeType: Cash
              - createdById: 402881e522cf4f9b0122cf5d82860002
                createdDate: '2017-03-01 10:27:20'
                exemptAmount: 0
                id: 402890555a7e9791015a87b17cf10077
                memoItemId: 402890555a7e9791015a87b082d5006a
                jurisdiction: CALIFORNIA
                locationCode: '06'
                name: STATE TAX
                taxAmount: 0.02
                taxCode: ServiceTaxCode
                taxCodeDescription: This is tax code description!
                taxDate: '2016-06-05'
                taxRate: 0.0625
                taxRateDescription: This is tax rate description!
                taxRateType: Percentage
                updatedById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:27:20'
                financeInformation:
                  onAccountAccountingCode: null
                  onAccountAccountingCodeType: null
                  salesTaxPayableAccountingCode: Check
                  salesTaxPayableAccountingCodeType: Cash
              success: true
          schema:
            $ref: '#/definitions/GETTaxationItemListType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: debitMemoKey
        description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

          '
        required: true
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/POSTTaxationItemListForDMType'
  /v1/debitmemos/{debitMemoKey}/einvoice/generate:
    put:
      summary: Generate an e-invoice file for a debit memo
      operationId: PUT_GenerateEInvoiceFileForDebitMemo
      description: 'Generates an e-invoice file for a debit memo.


        **Note**: This operation is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

        '
      tags:
      - Debit Memos
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: debitMemoKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001.

          '
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Remaining:
              type: number
              description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            RateLimit-Reset:
              type: number
              description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

                '
            Zuora-Request-Id:
              type: string
              minLength: 36
              maxLength: 36
              description: 'The Zuora internal identifier of the API call. You cannot control the value of this header.

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: '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.

                '
          examples:
            application/json:
              success: true
          description: ''
          schema:
            $ref: '#/definitions/CommonResponseType'
definitions:
  GETDebitMemoItemTypewithSuccess:
    allOf:
    - properties:
        amount:
          description: 'The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.

            '
          format: double
          type: number
        amountWithoutTax:
          description: 'The debit memo item amount excluding tax.

            '
          format: double
          type: number
        appliedToItemId:
          description: 'The parent debit memo item that this debit memo items is applied to if this item is discount.

            '
          type: string
        balance:
          description: 'The balance of the debit memo item.

            '
          format: double
          type: number
        beAppliedAmount:
          description: 'The applied amount of the debit memo item.

            '
          format: double
          type: number
        comment:
          description: 'Comments about the debit memo item.


            **Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        createdById:
          description: 'The ID of the Zuora user who created the debit memo item.

            '
          type: string
        createdDate:
          description: 'The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.

            '
          format: date-time
          type: string
        description:
          description: 'The description of the debit memo item.


            **Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: boolean
        financeInformation:
          description: 'Container for the finance information related to the debit memo item.

            '
          properties:
            deferredRevenueAccountingCode:
              description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.

                '
              type: string
            deferredRevenueAccountingCodeType:
              description: 'The type of the deferred revenue accounting code, such as Deferred Revenue.

                '
              type: string
            recognizedRevenueAccountingCode:
              description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

                '
              type: string
            recognizedRevenueAccountingCodeType:
              description: 'The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.

                '
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              type: string
            revenueScheduleNumber:
              description: 'The revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001.

                '
              type: string
          type: object
        id:
          description: 'The ID of the debit memo item.

            '
          type: string
        processingType:
          description: "The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. \n"
          type: string
        quantity:
          description: 'The number of units for the debit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: 'The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.

            '
          format: date
          type: string
        serviceStartDate:
          description: 'The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.

            '
          format: date
          type: string
        sku:
          description: 'The SKU for the product associated with the debit memo item.

            '
          type: string
        skuName:
          description: 'The name of the SKU.

            '
          type: string
        soldToContactId:
          description: 'The ID of the sold-to contact associated with the invoice item.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        soldToContactSnapshotId:
          description: "The ID of the sold-to contact snapshot associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.               \n"
          type: string
        sourceItemId:
          description: 'The ID of the source item.

            '
          type: string
        sourceItemType:
          description: 'The type of the source item.

            '
          enum:
          - CreditMemoItem
          - SubscriptionComponent
          - InvoiceDetail
          - ProductRatePlanCharge
          type: string
        subscriptionId:
          description: 'The ID of the subscription associated with the debit memo item.

            '
          type: string
        taxItems:
          description: "Container for the taxation items of the debit memo item. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
          items:
            $ref: '#/definitions/GETDMTaxItemType'
          type: array
        taxMode:
          description: 'The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.

            '
          enum:
          - TaxExclusive
          - TaxInclusive
          type: string
        taxationItems:
          description: "Container for the taxation items of the debit memo item. \n\n**Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
          properties:
            data:
              description: 'List of taxation items.

                '
              items:
                $ref: '#/definitions/GETDMTaxItemTypeNew'
              type: array
            nextPage:
              description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

                '
              format: URL
              type: string
          type: object
        unitOfMeasure:
          description: 'The units to measure usage.

            '
          type: string
        unitPrice:
          description: 'The per-unit price of the debit memo item.

            '
          format: double
          type: number
        updatedById:
          description: 'The ID of the Zuora user who last updated the debit memo item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
    title: items
  GetDebitMemoApplicationPartCollectionType:
    properties:
      applicationParts:
        description: 'Container for application parts.

          '
        items:
          $ref: '#/definitions/GetDebitMemoApplicationPartType'
        type: array
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  BulkDebitMemosResponseType:
    allOf:
    - properties:
        memos:
          description: 'The container for a list of debit memos.

            '
          items:
            $ref: '#/definitions/GETDebitMemoType'
          maxItems: 50
          type: array
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
  POSTUploadFileResponse:
    properties:
      fileId:
        description: 'The unique ID of the uploaded PDF file.

          '
        type: string
      success:
        description: 'Indicates whether the call succeeded.

          '
        type: boolean
    type: object
  PutDebitMemoTaxItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the taxation item in the debit memo item.

            '
          format: double
          type: number
        financeInformation:
          description: 'Container for the finance information related to the taxation item in the debit memo item.

            '
          properties:
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        id:
          description: 'The ID of the taxation item in the debit memo item.

            '
          type: string
        jurisdiction:
          description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

            '
          type: string
        locationCode:
          description: 'The identifier for the location based on the value of the `taxCode` field.

            '
          type: string
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

            '
          type: string
        taxCodeDescription:
          description: 'The description of the tax code.

            '
          type: string
        taxDate:
          description: 'The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        taxExemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        taxName:
          description: 'The name of taxation.

            '
          type: string
        taxRate:
          description: 'The tax rate applied to the debit memo.

            '
          format: double
          type: number
        taxRateDescription:
          description: 'The description of the tax rate.

            '
          type: string
        taxRateType:
          description: 'The type of the tax rate applied to the debit memo.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - id
      type: object
    - $ref: '#/definitions/DebitTaxationItemObjectCustomFields'
    title: taxItems
  CommonResponseType:
    properties:
      processId:
        description: 'The Id of the process that handle the operation.

          '
        type: string
      reasons:
        items:
          properties:
            code:
              description: 'The error code of response.

                '
              type: string
            message:
              description: 'The detail information of the error response

                '
              type: string
          type: object
        type: array
      success:
        description: 'Indicates whether the call succeeded.

          '
        type: boolean
    type: object
  DebitMemoTaxItemFromInvoiceTaxItemType:
    properties:
      amount:
        description: 'The amount of the debit memo taxation item.

          '
        format: double
        type: number
      financeInformation:
        description: 'Container for the finance information related to the source taxation item.

          '
        properties:
          salesTaxPayableAccountingCode:
            description: 'The accounting code for the sales taxes payable.

              '
            maxLength: 100
            minLength: 0
            type: string
        type: object
      jurisdiction:
        description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

          '
        type: string
      locationCode:
        description: 'The identifier for the location based on the value of the `taxCode` field.

          '
        type: string
      sourceTaxItemId:
        description: 'The ID of the source taxation item.

          '
        type: string
      taxCode:
        description: 'The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

          '
        type: string
      taxCodeDescription:
        description: 'The description of the tax code.

          '
        type: string
      taxDate:
        description: 'The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.

          '
        format: date
        type: string
      taxExemptAmount:
        description: 'The calculated tax amount excluded due to the exemption.

          '
        format: double
        type: number
      taxName:
        description: 'The name of taxation.

          '
        type: string
      taxRate:
        description: 'The tax rate applied to the debit memo.

          '
        format: double
        type: number
      taxRateDescription:
        description: 'The description of the tax rate.

          '
        type: string
      taxRateType:
        description: 'The type of the tax rate applied to the debit memo.

          '
        enum:
        - Percentage
        - FlatFee
        type: string
    title: taxItems
    type: object
  PostDebitMemoEmailType:
    example:
      emailAddresses: contact1@example.com,contact2@example.com
      includeAdditionalEmailAddresses: false
      pdfFileId: 162297b6f8d94edc81373f6037af76fa
      useEmailTemplateSetting: false
    properties:
      emailAddresses:
        description: 'The valid email addresses you want to email a debit memo to. Use commas to separate email addresses.


          **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`.

          '
        type: string
      includeAdditionalEmailAddresses:
        default: false
        description: "Indicates whether to send a debit memo to the additional email addresses of the memo account. \n\n\nYou can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information.\n"
        enum:
        - true
        - false
        type: boolean
      pdfFileId:
        description: "The ID of the PDF file that you want to send in the email. \n\nIf you do not specify any PDF file ID, the latest PDF file generated for the debit memo is sent in the email.\n"
        type: string
      useEmailTemplateSetting:
        default: false
        description: "Indicates whether to email a debit memo based on the email template setting. \n\nIf you set this field to `true`, the debit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.\n"
        enum:
        - true
        - false
        type: boolean
    type: object
  DebitMemoCollectResponse:
    allOf:
    - properties:
        appliedCreditMemos:
          description: 'The information about which credit memo applied to the specific debit memo.

            '
          items:
            $ref: '#/definitions/DebitMemoCollectResponseAppliedCreditMemos'
          type: array
        appliedPayments:
          description: 'The information about which payment applied to the specific debit memo.

            '
          items:
            $ref: '#/definitions/DebitMemoCollectResponseAppliedPayments'
          type: array
        debitMemo:
          description: 'The information about the debit memo that just collected.

            '
          properties:
            id:
              description: 'The unique ID of the debit memo.

                '
              type: string
            number:
              description: 'The unique identification number of the debit memo.

                '
              type: string
          type: object
        organizationLabel:
          description: 'The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is enabled.

            '
          type: string
        processedPayment:
          description: 'The information about the payment that newly processed to the debit memo.

            '
          properties:
            amount:
              description: 'The total amount of the payment.

                '
              format: double
              type: number
            gatewayId:
              description: 'The ID of the gateway instance that processes the payment.

                '
              type: string
            gatewayResponse:
              description: 'The message returned from the payment gateway for the payment. This message is gateway-dependent.

                '
              type: string
            gatewayResponseCode:
              description: 'The code returned from the payment gateway for the payment. This code is gateway-dependent.

                '
              type: string
            id:
              description: 'The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

                '
              type: string
            number:
              description: 'The unique identification number of the payment. For example, P-00000001.

                '
              type: string
            paymentMethodId:
              description: 'The unique ID of the payment method that the customer used to make the payment.

                '
              type: string
            status:
              description: 'The status of the payment.

                '
              enum:
              - Processing
              - Processed
              - Error
              - Canceled
              type: string
          type: object
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
  DebitMemoFromInvoiceType:
    allOf:
    - properties:
        autoPay:
          description: "Whether debit memos are automatically picked up for processing in the corresponding payment run. \nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
          type: boolean
        autoPost:
          default: false
          description: "Whether to automatically post the debit memo after it is created. \nSetting this field to `true`, you do not need to separately call the [Post debit memo](/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo.\n"
          type: boolean
        comment:
          description: "Comments about the debit memo. \n"
          maxLength: 255
          minLength: 0
          type: string
        effectiveDate:
          description: 'The date when the debit memo takes effect.

            '
          format: date
          type: string
        invoiceId:
          description: "The ID of the invoice that the debit memo is created from.\n* If this field is specified, its value must be the same as the value of the `invoiceId` path parameter. Otherwise, its value overrides the value of the `invoiceId` path parameter. \n* If this field is not specified, the value of the `invoiceId` path parameter is used. \n"
          type: string
        items:
          description: 'Container for items. The maximum number of items is 1,000.

            '
          items:
            $ref: '#/definitions/DebitMemoItemFromInvoiceItemType'
          maxItems: 1000
          type: array
        reasonCode:
          description: '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.

            '
          type: string
        taxAutoCalculation:
          default: true
          description: 'Whether to automatically calculate taxes in the debit memo.

            '
          type: boolean
      type: object
    - $ref: '#/definitions/DebitMemoObjectNSFields'
    - $ref: '#/definitions/DebitMemoObjectCustomFields'
    example:
      autoPay: true
      comment: the comment
      effectiveDate: '2017-11-30'
      items:
      - amount: 1
        autoPost: false
        comment: This is comment!
        invoiceItemId: 402890555a7d4022015a7dadb3b700a6
        quantity: 1
        serviceEndDate: '2017-11-30'
        serviceStartDate: '2017-11-01'
        skuName: SKU-30
        taxItems:
        - amount: 0.01
          jurisdiction: CALIFORNIA
          locationCode: '06'
          sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1
          taxCode: null
          taxCodeDescription: null
          taxDate: '2017-11-30'
          taxExemptAmount: 0.0
          taxName: STATE TAX
          taxRate: 0.0625
          taxRateDescription: This is tax rate description!
          taxRateType: Percentage
        taxMode: TaxExclusive
        unitOfMeasure: Test_UOM
      reasonCode: Charge Dispute
  POSTBulkDebitMemosRequestType:
    discriminator: sourceType
    properties:
      sourceType:
        description: "The type of the source where debit memos are created. \n\nThis enum field has the following values:\n- `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices.\n- `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges.\n\nThe specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field.\n- To view the `memos` schema if you set the `sourceType` field to `Invoice`, select `DebitMemosFromInvoices` from the following drop-down list.\n- To view the `memos` schema if you set the `sourceType` field to `Standalone`, select `DebitMemosFromCharges` from the following drop-down list.\n"
        enum:
        - Invoice
        - Standalone
        type: string
    required:
    - sourceType
    type: object
  GETDebitMemoItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.

            '
          format: double
          type: number
        amountWithoutTax:
          description: 'The debit memo item amount excluding tax.

            '
          format: double
          type: number
        appliedToItemId:
          description: 'The parent debit memo item that this debit memo items is applied to if this item is discount.

            '
          type: string
        balance:
          description: 'The balance of the debit memo item.

            '
          format: double
          type: number
        beAppliedAmount:
          description: 'The applied amount of the debit memo item.

            '
          format: double
          type: number
        comment:
          description: 'Comments about the debit memo item.


            **Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        createdById:
          description: 'The ID of the Zuora user who created the debit memo item.

            '
          type: string
        createdDate:
          description: 'The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.

            '
          format: date-time
          type: string
        description:
          description: 'Description about the debit memo item.


            **Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: boolean
        financeInformation:
          description: 'Container for the finance information related to the debit memo item.

            '
          properties:
            deferredRevenueAccountingCode:
              description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.

                '
              type: string
            deferredRevenueAccountingCodeType:
              description: 'The type of the deferred revenue accounting code, such as Deferred Revenue.

                '
              type: string
            recognizedRevenueAccountingCode:
              description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

                '
              type: string
            recognizedRevenueAccountingCodeType:
              description: 'The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount.

                '
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              type: string
            revenueScheduleNumber:
              description: 'The revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001.

                '
              type: string
          type: object
        id:
          description: 'The ID of the debit memo item.

            '
          type: string
        processingType:
          description: "The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. \n"
          type: string
        quantity:
          description: 'The number of units for the debit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: 'The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field.

            '
          format: date
          type: string
        serviceStartDate:
          description: 'The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge.

            '
          format: date
          type: string
        sku:
          description: 'The SKU for the product associated with the debit memo item.

            '
          type: string
        skuName:
          description: 'The name of the SKU.

            '
          type: string
        soldToContactId:
          description: 'The ID of the sold-to contact associated with the invoice item.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        soldToContactSnapshotId:
          description: "The ID of the sold-to contact snapshot associated with the invoice item.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.             \n"
          type: string
        sourceItemId:
          description: 'The ID of the source item.

            '
          type: string
        sourceItemType:
          description: 'The type of the source item.

            '
          enum:
          - CreditMemoItem
          - SubscriptionComponent
          - InvoiceDetail
          - ProductRatePlanCharge
          type: string
        subscriptionId:
          description: 'The ID of the subscription associated with the debit memo item.

            '
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        taxItems:
          description: "Container for the taxation items of the debit memo item.. \n\n**Note**: This field is not available if you set the `zuora-version` request header to `239.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).\n"
          items:
            $ref: '#/definitions/GETDMTaxItemType'
          type: array
        taxMode:
          description: 'The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.

            '
          enum:
          - TaxExclusive
          - TaxInclusive
          type: string
        taxationItems:
          description: 'Container for the taxation items of the debit memo item.


            **Note**: This field is only available if you set the `zuora-version` request header to `239.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          properties:
            data:
              description: 'List of taxation items.

                '
              items:
                $ref: '#/definitions/GETDMTaxItemTypeNew'
              type: array
            nextPage:
              description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

                '
              format: URL
              type: string
          type: object
        unitOfMeasure:
          description: 'The units to measure usage.

            '
          type: string
        unitPrice:
          description: 'The per-unit price of the debit memo item.

            '
          format: double
          type: number
        updatedById:
          description: 'The ID of the Zuora user who last updated the debit memo item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
  GETDMTaxItemType:
    allOf:
    - properties:
        appliedAmount:
          description: 'The applied amount of the taxation item.

            '
          format: double
          type: number
        creditAmount:
          description: "The amount of credit memos applied to the debit memo. \n"
          format: double
          type: number
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        financeInformation:
          description: 'Container for the finance information related to the taxation item.

            '
          properties:
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

                '
              type: string
            salesTaxPayableAccountingCodeType:
              description: 'The type of the accounting code for the sales taxes payable.

                '
              type: string
          type: object
        id:
          description: 'The ID of the taxation item.

            '
          type: string
        jurisdiction:
          description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

            '
          type: string
        locationCode:
          description: 'The identifier for the location based on the value of the `taxCode` field.

            '
          type: string
        name:
          description: 'The name of the taxation item.

            '
          type: string
        paymentAmount:
          description: "The amount of payments applied to the debit memo. \n"
          format: double
          type: number
        refundAmount:
          description: 'The amount of the refund on the taxation item.

            '
          format: double
          type: number
        sourceTaxItemId:
          description: 'The ID of the source taxation item.

            '
          type: string
        taxAmount:
          description: 'The amount of taxation.

            '
          format: double
          type: number
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

            '
          type: string
        taxCodeDescription:
          description: 'The description of the tax code.

            '
          type: string
        taxDate:
          description: 'The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the debit memo.

            '
          format: double
          type: number
        taxRateDescription:
          description: 'The description of the tax rate.

            '
          type: string
        taxRateType:
          description: 'The type of the tax rate.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the taxation item.

            '
          format: double
          type: number
      type: object
    - $ref: '#/definitions/DebitTaxationItemObjectCustomFields'
    title: taxItems
  GETDebitMemoCollectionType:
    properties:
      debitmemos:
        description: 'Container for debit memos.

          '
        items:
          $ref: '#/definitions/GETDebitMemoTypewithSuccess'
        type: array
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  DebitMemoObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Debit Memo object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.

        '
    description: 'Container for custom fields of a Debit Memo object.

      '
    title: debitMemoFieldsCustom
    type: object
  GETDebitMemoItemCollectionType:
    properties:
      items:
        description: 'Container for debit memo items.

          '
        items:
          $ref: '#/definitions/GETDebitMemoItemTypewithSuccess'
        type: array
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  PUTBatchDebitMemosRequest:
    example:
      debitMemos:
      - dueDate: '2017-12-28'
        id: 402890d25f9f083f015f9f28041d0008
      - dueDate: '2017-12-20'
        id: 402890555a87d7f5015a892f2ba10057
    properties:
      debitMemos:
        description: 'Container for debit memo update details.

          '
        items:
          $ref: '#/definitions/BatchDebitMemoType'
        type: array
    type: object
  PUTBulkDebitMemosRequestType:
    allOf:
    - properties:
        memos:
          description: 'The container for a list of debit memos. The maximum number of debit memos is 50.

            '
          items:
            $ref: '#/definitions/PUTDebitMemoWithIdType'
          maxItems: 50
          title: memos
          type: array
      type: object
    example:
      memos:
      - autoPay: true
        comment: new comment
        dueDate: '2017-05-20'
        effectiveDate: '2017-04-17'
        id: 4028905f5a890526015a8db30954007a
        items:
        - amount: 1
          comment: This is comment!
          id: 402890555b797b57015b7986fc1a001c
          quantity: 1
          serviceEndDate: '2016-11-30'
          serviceStartDate: '2016-11-01'
          skuName: SKU-1
          taxItems:
          - amount: 0.03
            id: 402890555b797b57015b7986fc3c001d
            jurisdiction: CALIFORNIA
            locationCode: '06'
            taxCode: null
            taxCodeDescription: This is tax code description!
            taxDate: '2016-11-30'
            taxExemptAmount: 0
            taxName: STATE TAX1
            taxRate: 0.0625
            taxRateDescription: This is tax rate description!
            taxRateType: Percentage
          unitOfMeasure: Test_UOM
        - amount: 2
          comment: This is comment!
          id: 402890555b797b57015b7986fc41001e
          serviceEndDate: '2016-11-30'
          serviceStartDate: '2016-11-01'
          skuName: SKU-2
          taxItems:
          - amount: 0.06
            id: 402890555b797b57015b7986fc4c001f
            jurisdiction: CALIFORNIA
            locationCode: '06'
            taxCode: null
            taxCodeDescription: This is tax code description!
            taxDate: '2016-11-30'
            taxExemptAmount: 0
            taxName: STATE TAX2
            taxRate: 0.0625
            taxRateDescription: This is tax rate description!
            taxRateType: Percentage
          unitOfMeasure: Test_UOM
        reasonCode: Correcting invoice error
  DebitMemoFromChargeType:
    allOf:
    - properties:
        accountId:
          description: '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.

            '
          type: string
        accountNumber:
          description: '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.

            '
          type: string
        autoPay:
          description: "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
          type: boolean
        autoPost:
          default: false
          description: "Whether to automatically post the debit memo after it is created. \n\nSetting this field to `true`, you do not need to separately call the [Post a debit memo](/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo.\n"
          type: boolean
        charges:
          description: 'Container for product rate plan charges. The maximum number of items is 1,000.

            '
          items:
            $ref: '#/definitions/DebitMemoFromChargeDetailType'
          maxItems: 1000
          type: array
        comment:
          description: 'Comments about the debit memo.

            '
          maxLength: 255
          minLength: 0
          type: string
        currency:
          description: "The code of a currency as defined in Billing Settings through the Zuora UI.\n\nIf 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.\n \n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies\" target=\"_blank\">Multiple Currencies</a> feature in the **Early Adopter** phase enabled.\n"
          type: string
        customRates:
          description: '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.

            '
          items:
            $ref: '#/definitions/DebitMemoFromChargeCustomRatesType'
          maxItems: 2
          type: array
        dueDate:
          description: 'The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        effectiveDate:
          description: 'The date when the debit memo takes effect.

            '
          format: date
          type: string
        reasonCode:
          description: '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.

            '
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoObjectNSFields'
    - $ref: '#/definitions/DebitMemoObjectCustomFields'
    example:
      accountId: 402890555a7e9791015a7f15fe44001c
      autoPay: true
      autoPost: false
      charges:
      - amount: 30
        chargeId: 402890555a87d7f5015a892cae910050
        comment: this is comment1
        quantity: 1
      - amount: 20
        chargeId: 402890555a87d7f5015a892dff7f0053
        comment: this is comment2
      comment: the comment
      currency: USD
      customRates:
      - currency: CAD
        customFxRate: 2.22
        rateDate: '2022-10-21'
      - currency: EUR
        customFxRate: 2.22
        rateDate: '2022-10-21'
      effectiveDate: '2017-10-17'
      reasonCode: Correcting invoice error
    title: charges
  GETTaxationItemListType:
    properties:
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
      taxationItems:
        description: 'Container for taxation items.

          '
        items:
          $ref: '#/definitions/GETTaxationItemTypewithSuccess'
        type: array
    type: object
  DebitMemoCollectResponseAppliedCreditMemos:
    allOf:
    - properties:
        appliedAmount:
          description: 'The applied amount of the credit memo to the debit memo.

            '
          format: double
          type: number
        id:
          description: 'The unique ID of the credit memo.

            '
          type: string
        number:
          description: 'The unique identification number of the credit memo.

            '
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the credit memo after applied to the debit memo.

            '
          format: double
          type: number
      type: object
  DebitTaxationItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Debit Taxation Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.

        '
    description: 'Container for custom fields of a Debit Taxation Item object.

      '
    title: debitTaxationItemFieldsCustom
    type: object
  DebitMemoObjectNSFields:
    description: 'Container for Debit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

      '
    properties:
      IntegrationId__NS:
        description: 'ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

          '
        maxLength: 255
        type: string
      IntegrationStatus__NS:
        description: 'Status of the debit memo''s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

          '
        maxLength: 255
        type: string
      SyncDate__NS:
        description: 'Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

          '
        maxLength: 255
        type: string
    title: debitMemoFieldsNS
    type: object
  GETTaxationItemsOfDebitMemoItemType:
    allOf:
    - properties:
        data:
          description: 'Container for the taxation items of the debit memo item.

            '
          items:
            $ref: '#/definitions/GETDMTaxItemTypeNew'
          type: array
        nextPage:
          description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

            '
          format: URL
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
      type: object
  GETDMTaxItemTypeNew:
    allOf:
    - properties:
        balance:
          description: 'The balance of the taxation item.

            '
          format: double
          type: number
        creditAmount:
          description: "The amount of credit memos applied to the debit memo. \n"
          format: double
          type: number
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        financeInformation:
          description: 'Container for the finance information related to the taxation item.

            '
          properties:
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

                '
              type: string
            salesTaxPayableAccountingCodeType:
              description: 'The type of the accounting code for the sales taxes payable.

                '
              type: string
          type: object
        id:
          description: 'The ID of the taxation item.

            '
          type: string
        jurisdiction:
          description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

            '
          type: string
        locationCode:
          description: 'The identifier for the location based on the value of the `taxCode` field.

            '
          type: string
        name:
          description: 'The name of the taxation item.

            '
          type: string
        paymentAmount:
          description: "The amount of payments applied to the debit memo. \n"
          format: double
          type: number
        sourceTaxItemId:
          description: 'The ID of the source taxation item.

            '
          type: string
        taxAmount:
          description: 'The amount of taxation.

            '
          format: double
          type: number
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

            '
          type: string
        taxCodeDescription:
          description: 'The description of the tax code.

            '
          type: string
        taxDate:
          description: 'The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the debit memo.

            '
          format: double
          type: number
        taxRateDescription:
          description: 'The description of the tax rate.

            '
          type: string
        taxRateType:
          description: 'The type of the tax rate.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      type: object
    - $ref: '#/definitions/DebitTaxationItemObjectCustomFields'
    title: data
  PUTDebitMemoItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.

            '
          format: double
          type: number
        comment:
          description: 'Comments about the debit memo item.

            '
          type: string
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.            \n"
          type: boolean
        financeInformation:
          description: 'Container for the finance information related to the debit memo item.

            '
          properties:
            deferredRevenueAccountingCode:
              description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.

                '
              maxLength: 100
              minLength: 0
              type: string
            recognizedRevenueAccountingCode:
              description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

                '
              maxLength: 100
              minLength: 0
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        id:
          description: 'The ID of the debit memo item.

            '
          maxLength: 32
          minLength: 32
          type: string
        quantity:
          description: 'The number of units for the debit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: 'The service end date of the debit memo item.

            '
          format: date
          type: string
        serviceStartDate:
          description: "The service start date of the debit memo item. \n"
          format: date
          type: string
        skuName:
          description: 'The name of the SKU.

            '
          type: string
        taxItems:
          description: 'Container for debit memo taxation items.

            '
          items:
            $ref: '#/definitions/PutDebitMemoTaxItemType'
          type: array
        unitOfMeasure:
          description: 'The definable unit that you measure when determining charges.

            '
          type: string
      required:
      - id
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
    title: items
  GETDebitMemoType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the debit memo.

            '
          type: string
        accountNumber:
          description: "The number of the customer account associated with the debit memo.       \n"
          type: string
        amount:
          description: 'The total amount of the debit memo.

            '
          format: double
          type: number
        autoPay:
          description: '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.

            '
          type: boolean
        balance:
          description: 'The balance of the debit memo.

            '
          format: double
          type: number
        beAppliedAmount:
          description: 'The amount that is applied to the debit memo.

            '
          format: double
          type: number
        billToContactId:
          description: 'The ID of the bill-to contact associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        billToContactSnapshotId:
          description: 'The ID of the bill-to contact snapshot associated with the debit memo.


            The value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.

            '
          type: string
        cancelledById:
          description: 'The ID of the Zuora user who cancelled the debit memo.

            '
          type: string
        cancelledOn:
          description: 'The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        comment:
          description: 'Comments about the debit memo.

            '
          type: string
        createdById:
          description: 'The ID of the Zuora user who created the debit memo.

            '
          type: string
        createdDate:
          description: 'The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.

            '
          format: date-time
          type: string
        debitMemoDate:
          description: 'The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.

            '
          format: date
          type: string
        dueDate:
          description: 'The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        einvoiceErrorCode:
          description: 'The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceErrorMessage:
          description: 'The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceFileId:
          description: 'The ID of the e-invoice file generated for the debit memo.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceStatus:
          description: "The status of the e-invoice file generation for the debit memo. \n\n- If e-invoice file generation succeeds, both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
          enum:
          - Processing
          - Success
          - Failed
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the debit memo item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: boolean
        id:
          description: 'The unique ID of the debit memo.

            '
          type: string
        latestPDFFileId:
          description: 'The ID of the latest PDF file generated for the debit memo.

            '
          type: string
        number:
          description: 'The unique identification number of the debit memo.

            '
          type: string
        organizationLabel:
          description: 'The organization that this object belongs to.


            Note: This field is available only when the Multi-Org feature is enabled.

            '
          type: string
        paymentTerm:
          description: 'The name of the payment term assoicated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        postedById:
          description: 'The ID of the Zuora user who posted the debit memo.

            '
          type: string
        postedOn:
          description: 'The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction. The value must be an existing reason code or empty.

            '
          type: string
        referredCreditMemoId:
          description: 'The ID of the credit memo from which the debit memo was created.

            '
          type: string
        referredInvoiceId:
          description: 'The ID of a referred invoice.

            '
          type: string
        sequenceSetId:
          description: "The ID of the sequence set associated with the debit memo.\n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.\n             \n"
          type: string
        sourceType:
          description: 'The type of the debit memo source.

            '
          enum:
          - Subscription
          - Standalone
          - Order
          - Consolidation
          - Invoice
          - CreditMemo
          type: string
        status:
          description: 'The status of the debit memo.

            '
          enum:
          - Draft
          - Posted
          - Canceled
          - Error
          - PendingForTax
          - Generating
          - CancelInProgress
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        targetDate:
          description: 'The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.

            '
          format: date
          type: string
        taxAmount:
          description: 'The amount of taxation.

            '
          format: double
          type: number
        taxMessage:
          description: 'The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.

            '
          type: string
        taxStatus:
          description: 'The status of tax calculation related to the debit memo.


            **Note**: This field is only applicable to tax calculation by third-party tax engines.

            '
          enum:
          - Complete
          - Error
          type: string
        totalTaxExemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        transferredToAccounting:
          description: 'Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.

            '
          enum:
          - Processing
          - 'Yes'
          - 'No'
          - Error
          - Ignore
          type: string
        updatedById:
          description: 'The ID of the Zuora user who last updated the debit memo.

            '
          type: string
        updatedDate:
          description: 'The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoObjectNSFields'
    - $ref: '#/definitions/DebitMemoObjectCustomFields'
    title: memos
  DebitMemoFromChargeDetailType:
    allOf:
    - properties:
        amount:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          format: double
          type: number
        chargeId:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        comment:
          description: '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.

            '
          maxLength: 255
          minLength: 0
          type: string
        description:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          maxLength: 255
          minLength: 0
          type: string
        financeInformation:
          description: 'Container for the finance information related to the product rate plan charge associated with the debit memo.

            '
          properties:
            deferredRevenueAccountingCode:
              description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.

                '
              maxLength: 100
              minLength: 0
              type: string
            recognizedRevenueAccountingCode:
              description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

                '
              maxLength: 100
              minLength: 0
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        memoItemAmount:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          format: double
          type: number
        productRatePlanChargeId:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        quantity:
          description: 'The number of units for the debit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: '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.

            '
          format: date
          type: string
        serviceStartDate:
          description: '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.

            '
          format: date
          type: string
      required:
      - chargeId
      - productRatePlanChargeId
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
    title: charges
  GETDebitMemoTypewithSuccess:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the debit memo.

            '
          type: string
        accountNumber:
          description: 'The number of the customer account associated with the debit memo.

            '
          type: string
        amount:
          description: 'The total amount of the debit memo.

            '
          format: double
          type: number
        autoPay:
          description: "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.      \n"
          type: boolean
        balance:
          description: 'The balance of the debit memo.

            '
          format: double
          type: number
        beAppliedAmount:
          description: 'The applied amount of the debit memo.

            '
          format: double
          type: number
        billToContactId:
          description: 'The ID of the bill-to contact associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        cancelledById:
          description: 'The ID of the Zuora user who cancelled the debit memo.

            '
          type: string
        cancelledOn:
          description: 'The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        comment:
          description: 'Comments about the debit memo.

            '
          type: string
        createdById:
          description: 'The ID of the Zuora user who created the debit memo.

            '
          type: string
        createdDate:
          description: 'The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10.

            '
          format: date-time
          type: string
        debitMemoDate:
          description: 'The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20.

            '
          format: date
          type: string
        dueDate:
          description: 'The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        einvoiceErrorCode:
          description: 'The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceErrorMessage:
          description: 'The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceFileId:
          description: 'The ID of the e-invoice file generated for the debit memo.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing" target="_blank">E-Invoicing</a> feature in **Early Adopter** phase enabled.

            '
          type: string
        einvoiceStatus:
          description: "The status of the e-invoice file generation for the debit memo. \n\n- If e-invoice file generation succeeds, both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file.\n- If a failure occurs during e-invoice file generation, an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/E-Invoicing\" target=\"_blank\">E-Invoicing</a> feature in **Early Adopter** phase enabled.\n"
          enum:
          - Processing
          - Success
          - Failed
          type: string
        id:
          description: 'The unique ID of the debit memo.

            '
          type: string
        latestPDFFileId:
          description: 'The ID of the latest PDF file generated for the debit memo.

            '
          type: string
        number:
          description: 'The unique identification number of the debit memo.

            '
          type: string
        paymentTerm:
          description: 'The name of the payment term associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        postedById:
          description: 'The ID of the Zuora user who posted the debit memo.

            '
          type: string
        postedOn:
          description: 'The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction. The value must be an existing reason code or empty.

            '
          type: string
        referredCreditMemoId:
          description: 'The ID of the credit memo from which the debit memo was created.

            '
          type: string
        referredInvoiceId:
          description: 'The ID of a referred invoice.

            '
          type: string
        sequenceSetId:
          description: 'The ID of the sequence set associated with the debit memo.


            The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled.

            '
          type: string
        sourceType:
          description: 'The type of the debit memo source.

            '
          enum:
          - Subscription
          - Standalone
          - Order
          - Consolidation
          - Invoice
          - CreditMemo
          type: string
        status:
          description: "The status of the debit memo. \n"
          enum:
          - Draft
          - Posted
          - Canceled
          - Error
          - PendingForTax
          - Generating
          - CancelInProgress
          type: string
        targetDate:
          description: 'The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20.

            '
          format: date
          type: string
        taxAmount:
          description: 'The amount of taxation.

            '
          format: double
          type: number
        taxMessage:
          description: 'The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.

            '
          type: string
        taxStatus:
          description: 'The status of tax calculation related to the debit memo.


            **Note**: This field is only applicable to tax calculation by third-party tax engines.

            '
          enum:
          - Complete
          - Error
          type: string
        totalTaxExemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        transferredToAccounting:
          description: "Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
          enum:
          - Processing
          - 'Yes'
          - 'No'
          - Error
          - Ignore
          type: string
        updatedById:
          description: 'The ID of the Zuora user who last updated the debit memo.

            '
          type: string
        updatedDate:
          description: 'The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:31:10.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoObjectNSFields'
    - $ref: '#/definitions/DebitMemoObjectCustomFields'
    title: debitmemos
  GETTaxationItemTypewithSuccess:
    allOf:
    - properties:
        createdById:
          description: 'The ID of the Zuora user who created the taxation item.

            '
          type: string
        createdDate:
          description: 'The date and time when the taxation item was created in the Zuora system, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        financeInformation:
          description: 'Container for the finance information related to the taxation item.

            '
          properties:
            accountsReceivableAccountingCode:
              description: 'The accounting code for accounts receivable.

                '
              type: string
            accountsReceivableAccountingCodeType:
              description: 'The type of the accounting code for accounts receivable.

                '
              type: string
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

                '
              type: string
            salesTaxPayableAccountingCodeType:
              description: 'The type of the accounting code for the sales taxes payable.

                '
              type: string
          type: object
        id:
          description: 'The ID of the taxation item.

            '
          type: string
        invoiceItemId:
          description: 'The ID of the invoice associated with the taxation item.

            '
          type: string
        jurisdiction:
          description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

            '
          type: string
        locationCode:
          description: 'The identifier for the location based on the value of the `taxCode` field.

            '
          type: string
        name:
          description: 'The name of the taxation item.

            '
          type: string
        taxAmount:
          description: 'The amount of the tax applied to the invoice.

            '
          format: double
          type: number
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to a specific invoice.

            '
          type: string
        taxCodeDescription:
          description: 'The description of the tax code.

            '
          type: string
        taxDate:
          description: 'The date when the tax is applied to the invoice.

            '
          format: date
          type: string
        taxMode:
          description: 'The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.

            '
          enum:
          - TaxInclusive
          - TaxExclusive
          type: string
        taxRate:
          description: 'The tax rate applied to the invoice.

            '
          format: double
          type: number
        taxRateDescription:
          description: 'The description of the tax rate.

            '
          type: string
        taxRateType:
          description: 'The type of the tax rate applied to the invoice.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
        updatedById:
          description: 'The ID of the Zuora user who last updated the taxation item.

            '
          type: string
        updatedDate:
          description: 'The date and time when the taxation item was last updated, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
    title: taxationItems
  BatchDebitMemoType:
    properties:
      dueDate:
        description: 'The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.

          '
        format: date
        type: string
      id:
        description: 'The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001.

          '
        type: string
    title: debitMemos
    type: object
  DebitMemoFromChargeCustomRatesType:
    allOf:
    - properties:
        currency:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        customFxRate:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          format: decimal
          type: number
        rateDate:
          description: '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](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          format: date
          type: string
      required:
      - currency
      - customFxRate
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
    title: customRates
  DebitMemoItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Debit Memo Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.

        '
    description: 'Container for custom fields of a Debit Memo Item object.

      '
    title: debitMemoItemFieldsCustom
    type: object
  DebitMemoCollectResponseAppliedPayments:
    allOf:
    - properties:
        appliedAmount:
          description: 'The applied amount of the payment to the debit memo.

            '
          format: double
          type: number
        id:
          description: 'The unique ID of the payment.

            '
          type: string
        number:
          description: 'The unique identification number of the payment.

            '
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the payment after applied to the debit memo.

            '
          format: double
          type: number
      type: object
  POSTTaxationItemForDMType:
    allOf:
    - properties:
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: double
          type: number
        financeInformation:
          description: 'Container for the finance information related to the taxation item.

            '
          properties:
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        jurisdiction:
          description: 'The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

            '
          type: string
        locationCode:
          description: 'The identifier for the location based on the value of the `taxCode` field.

            '
          type: string
        memoItemId:
          description: 'The ID of the debit memo that the taxation item is created for.

            '
          type: string
        name:
          description: 'The name of the taxation item.

            '
          type: string
        sourceTaxItemId:
          description: "The ID of the taxation item of the invoice, which the debit memo is created from. \n\nIf you want to use this REST API to create taxation items for a debit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call.\n\n**Note:** \n  - This field is only used if the debit memo is created from an invoice. \n  - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate.\n"
          type: string
        taxAmount:
          description: 'The amount of the tax applied to the debit memo.

            '
          format: double
          type: number
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

            '
          type: string
        taxCodeDescription:
          description: 'The description of the tax code.

            '
          type: string
        taxDate:
          description: 'The date when the tax is applied to the debit memo.

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the debit memo.

            '
          format: double
          type: number
        taxRateDescription:
          description: 'The description of the tax rate.

            '
          type: string
        taxRateType:
          description: 'The type of the tax rate applied to the debit memo.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - taxRate
      - jurisdiction
      - name
      - taxRateType
      - taxAmount
      type: object
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
    title: taxationItems
  GetDebitMemoApplicationPartType:
    properties:
      appliedAmount:
        description: 'The amount that is applied to the debit memo.

          '
        format: double
        type: number
      createdById:
        description: 'The ID of the Zuora user who created the payment or credit memo.

          '
        format: uuid
        type: string
      createdDate:
        description: 'The date and time when the payment or credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10.

          '
        format: date-time
        type: string
      creditMemoId:
        description: 'The ID of credit memo that is applied to the specified debit memo.

          '
        format: uuid
        type: string
      paymentId:
        description: 'The ID of the payment that is applied to the specified debit memo.

          '
        format: uuid
        type: string
      updatedById:
        description: 'The ID of the Zuora user who last updated the payment or credit memo.

          '
        format: uuid
        type: string
      updatedDate:
        description: 'The date and time when the payment or credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16.

          '
        format: date-time
        type: string
    title: applicationParts
    type: object
  POSTTaxationItemListForDMType:
    example:
      taxationItems:
      - exemptAmount: 0.0
        financeInformation:
          salesTaxPayableAccountingCode: Check
        jurisdiction: CALIFORNIA
        locationCode: '06'
        memoItemId: 402890555a7e9791015a87b082980068
        name: STATE TAX
        sourceTaxItemId: 402890555a7d4022015a7db254e200c2
        taxAmount: 0.01
        taxCode: ServiceTaxCode
        taxCodeDescription: This is tax code description!
        taxDate: '2016-06-05'
        taxRate: 0.0625
        taxRateDescription: This is tax rate description!
        taxRateType: Percentage
      - exemptAmount: 0.0
        financeInformation:
          salesTaxPayableAccountingCode: Check
        jurisdiction: CALIFORNIA
        locationCode: '06'
        memoItemId: 402890555a7e9791015a87b082d5006a
        name: STATE TAX
        sourceTaxItemId: 402890555a7d4022015a7db254e200c3
        taxAmount: 0.02
        taxCode: ServiceTaxCode
        taxCodeDescription: This is tax code description!
        taxDate: '2016-06-05'
        taxRate: 0.0625
        taxRateDescription: This is tax rate description!
        taxRateType: Percentage
    properties:
      taxationItems:
        description: 'Container for taxation items.

          '
        items:
          $ref: '#/definitions/POSTTaxationItemForDMType'
        type: array
    type: object
  PUTDebitMemoType:
    allOf:
    - properties:
        autoPay:
          description: "Whether debit memos are automatically picked up for processing in the corresponding payment run. \n\nBy default, debit memos are automatically picked up for processing in the corresponding payment run.\n"
          type: boolean
        comment:
          description: 'Comments about the debit memo.

            '
          maxLength: 255
          minLength: 0
          type: string
        dueDate:
          description: 'The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        effectiveDate:
          description: 'The date when the debit memo takes effect.

            '
          format: date
          type: string
        items:
          description: 'Container for debit memo items.

            '
          items:
            $ref: '#/definitions/PUTDebitMemoItemType'
          type: array
        reasonCode:
          description: '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

            '
          type: string
        transferredToAccounting:
          description: "Whether the debit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
          enum:
          - Processing
          - 'Yes'
          - 'No'
          - Error
          - Ignore
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoObjectNSFields'
    - $ref: '#/definitions/DebitMemoObjectCustomFields'
    example:
      autoPay: true
      comment: new comment
      dueDate: '2017-05-20'
      effectiveDate: '2017-04-17'
      items:
      - amount: 1
        comment: This is comment!
        id: 402890555b797b57015b7986fc1a001c
        quantity: 1
        serviceEndDate: '2016-11-30'
        serviceStartDate: '2016-11-01'
        skuName: SKU-1
        taxItems:
        - amount: 0.03
          id: 402890555b797b57015b7986fc3c001d
          jurisdiction: CALIFORNIA
          locationCode: '06'
          taxCode: null
          taxCodeDescription: This is tax code description!
          taxDate: '2016-11-30'
          taxExemptAmount: 0.0
          taxName: STATE TAX1
          taxRate: 0.0625
          taxRateDescription: This is tax rate description!
          taxRateType: Percentage
        unitOfMeasure: Test_UOM
      - amount: 2
        comment: This is comment!
        id: 402890555b797b57015b7986fc41001e
        serviceEndDate: '2016-11-30'
        serviceStartDate: '2016-11-01'
        skuName: SKU-2
        taxItems:
        - amount: 0.06
          id: 402890555b797b57015b7986fc4c001f
          jurisdiction: CALIFORNIA
          locationCode: '06'
          taxCode: null
          taxCodeDescription: This is tax code description!
          taxDate: '2016-11-30'
          taxExemptAmount: 0.0
          taxName: STATE TAX2
          taxRate: 0.0625
          taxRateDescription: This is tax rate description!
          taxRateType: Percentage
        unitOfMeasure: Test_UOM
      reasonCode: Correcting invoice error
  DebitMemoItemFromInvoiceItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the debit memo item.

            '
          format: double
          type: number
        comment:
          description: 'Comments about the debit memo item.

            **Note**: This field is not available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        description:
          description: 'The description of the debit memo item.

            **Note**: This field is only available if you set the `zuora-version` request header to `257.0` or later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          type: string
        financeInformation:
          description: 'Container for the finance information related to the debit memo item.

            '
          properties:
            deferredRevenueAccountingCode:
              description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.

                '
              maxLength: 100
              minLength: 0
              type: string
            recognizedRevenueAccountingCode:
              description: 'The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

                '
              maxLength: 100
              minLength: 0
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        invoiceItemId:
          description: 'The ID of the invoice item.

            '
          type: string
        quantity:
          description: 'The number of units for the debit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: 'The service end date of the debit memo item.

            '
          format: date
          type: string
        serviceStartDate:
          description: "The service start date of the debit memo item. \n"
          format: date
          type: string
        skuName:
          description: 'The name of the charge associated with the invoice.

            '
          type: string
        taxItems:
          description: 'Container for taxation items.

            '
          items:
            $ref: '#/definitions/DebitMemoTaxItemFromInvoiceTaxItemType'
          type: array
        taxMode:
          default: TaxExclusive
          description: 'The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax.


            **Note**: You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`.


            If you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for debit memo items. The corresponding invoice item must use the same tax engine as the debit memo item to calculate tax amounts.

            '
          enum:
          - TaxExclusive
          - TaxInclusive
          type: string
        unitOfMeasure:
          description: 'The definable unit that you measure when determining charges.

            '
          type: string
      required:
      - skuName
      - amount
      type: object
    - $ref: '#/definitions/DebitMemoItemObjectCustomFields'
    title: items
  DebitMemoCollectRequest:
    example:
      applicationOrder:
      - CreditMemo
      - UnappliedPayment
      applyCredit: true
      collect: true
      payment:
        gatewayId: 2c98902f6f1de6d1016f1ded559f3b9d
        paymentMethodId: 2c98902f6f1de6d1016f1dedba313ba2
    properties:
      applicationOrder:
        description: "The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`.\n\n**Note:**\n  - This field is valid only if the `applyCredit` field is set to `true`.\n  - 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.\n  - 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.\n"
        items:
          type: string
        type: array
      applyCredit:
        default: false
        description: '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.

          '
        type: boolean
      collect:
        default: false
        description: 'Indicates if the current request needs to collect payment or not.

          '
        type: boolean
      payment:
        description: 'Some detail info that would be used to processed an electronic payment.

          The info would only effect when `collect` set to `true`.

          '
        properties:
          gatewayId:
            description: '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.

              '
            type: string
          paymentMethodId:
            description: '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.

              '
            type: string
        type: object
    type: object
  PUTDebitMemoWithIdType:
    allOf:
    - properties:
        id:
          description: 'The ID of the debit memo.

            '
          type: string
      type: object
    - $ref: '#/definitions/PUTDebitMemoType'
  TaxationItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Taxation Item object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.

        '
    description: 'Container for custom fields of a Taxation Item object.

      '
    title: taxationItemFieldsCustom
    type: object
  POSTMemoPdfResponse:
    properties:
      success:
        description: 'Returns `true` if the request was processed successfully.

          '
        type: boolean
    type: object
parameters:
  GLOBAL_HEADER_Accept_Encoding:
    name: Accept-Encoding
    in: header
    required: false
    type: string
    description: "Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf 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.\n"
  GLOBAL_HEADER_Zuora_Org_Ids:
    name: Zuora-Org-Ids
    in: header
    required: false
    type: string
    description: "Comma separated IDs. If you have <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org\" target=\"_blank\">Zuora Multi-Org</a> enabled, \nyou 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.\n\nThe 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.\n\nIf the header is not set, the operation is performed in scope of the user's accessible orgs.\n"
  GLOBAL_HEADER_Idempotency_Key:
    name: Idempotency-Key
    in: header
    required: false
    type: string
    maxLength: 255
    description: "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. \n\nWith 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. \n"
  GLOBAL_HEADER_Content_Encoding:
    name: Content-Encoding
    in: header
    required: false
    type: string
    description: '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.

      '
  GLOBAL_HEADER_Zuora_Entity_Ids_Single:
    name: Zuora-Entity-Ids
    in: header
    required: false
    type: string
    description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/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.

      '
  GLOBAL_HEADER_Zuora_Track_Id:
    name: Zuora-Track-Id
    in: header
    required: false
    type: string
    maxLength: 64
    description: '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 (`''`).

      '
  GLOBAL_REQUEST_pageSize:
    name: pageSize
    in: query
    required: false
    type: integer
    maximum: 40
    default: 20
    description: 'The number of records returned per page in the response.

      '
  GLOBAL_HEADER_Authorization_OAuth_optional:
    name: Authorization
    in: header
    required: false
    type: string
    description: 'The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](/api-references/api/operation/createToken).

      '
  GLOBAL_REQUEST_page:
    name: page
    in: query
    required: false
    type: integer
    minimum: 1
    default: 1
    description: 'The index number of the page that you want to retrieve. This parameter is dependent on `pageSize`. You must set `pageSize` before specifying `page`. For example, if you set `pageSize` to `20` and `page` to `2`, the 21st to 40th records are returned in the response.

      '
x-tagGroups:
- name: Authentication
  tags:
  - OAuth
- name: Products
  tags:
  - Products
  - Catalog
  - Catalog Groups
  - Offers
  - Price Book Items
  - Product Rate Plans
  - Product Rate Plan Definitions
  - Product Rate Plan Charges
  - Product Charge Definitions
  - Product Rate Plan Charge Tiers
  - Zuora Revenue Integration
- name: Customer Accounts
  tags:
  - Accounts
  - Contacts
  - Contact Snapshots
- name: Orders and Subscriptions
  tags:
  - Sign Up
  - Orders
  - Order Actions
  - Order Line Items
  - Fulfillments
  - Ramps
  - Subscriptions
  - Rate Plans
- name: Advanced Consumption Billing
  tags:
  - Prepaid with Drawdown
- name: Usage
  tags:
  - Usage
- name: Billing Documents
  tags:
  - Delivery Adjustments
  - Billing Documents
  - Invoices
  - Credit Memos
  - Debit Memos
  - E-Invoicing
  - Invoice Schedules
  - Taxation Items
  - Sequence Sets
  - Operations
- name: Bill Runs
  tags:
  - Bill Run
  - Billing Preview Run
- name: Payment Methods
  tags:
  - Payment Methods
  - Custom Payment Method Types
  - Payment Method Updater
  - Payment Method Snapshots
  - Payment Method Transaction Logs
  - Hosted Pages
  - RSA Signatures
- name: Payments
  tags:
  - Payment Authorization
  - Payment Gateways
  - Payment Gateway Reconciliation
  - Payments
  - Payment Transaction Logs
  - Payment Runs
  - Payment Schedules
  - Refunds
- name: Finance
  tags:
  - Accounting Codes
  - Accounting Periods
  - Summary Journal Entries
  - Journal Runs
  - Mass Updater
- name: Events and Notifications
  tags:
  - Notifications
  - Custom Event Triggers
  - Custom Scheduled Events
- name: Custom Objects
  tags:
  - Custom Object Definitions
  - Custom Object Records
  - Custom Object Jobs
- name: System Health
  tags:
  - API Health
  - Bill Run Health
  - Electronic Payments Health
- name: Workflow
  tags:
  - Workflows
- name: Data Query
  tags:
  - Data Queries
- name: AQuA
  tags:
  - Aggregate Queries
- name: Deployment Manager
  tags:
  - Configuration Templates
- name: Multiple Organizations
  tags:
  - Data Labeling
- name: Order to Revenue
  tags:
  - Regenerate
- name: General-Purpose Operations
  tags:
  - Actions
  - Settings
  - Files
  - Imports
  - Custom Exchange Rates
  - Attachments
  - Describe