swagger: '2.0'
info:
  version: '2023-12-15'
  title: API Reference Accounting Codes Credit 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: Credit Memos
  description: 'Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice.


    For more information about credit 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/creditmemos:
    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 credit memo from a product rate plan charge. Zuora supports the creation of credit 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 credit 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 credit 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 credit memo from a charge
      operationId: POST_CreditMemoFromPrpc
      tags:
      - Credit 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: 402890555a87d7f5015a88c7a6830022
              number: CM00000015
              accountId: 402890555a7e9791015a7f15fe44001c
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-10-17'
              targetDate: null
              postedById: null
              postedOn: null
              status: Draft
              amount: 2020
              taxAmount: 0
              totalTaxExemptAmount: 0
              unappliedAmount: 2020
              refundAmount: 0
              appliedAmount: 0
              comment: the comment
              source: AdhocFromPrpc
              sourceType: Standalone
              sourceId: null
              referredInvoiceId: null
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-01 15:31:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 15:31:10'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: null
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              excludeItemBillingFromRevenueAccounting: true
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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/CreditMemoFromChargeType'
    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 credit memos. \n\nFor a use case of this operation, see [Get credit memo](/rest-api/general-concepts/authentication//#Get-credit-memo).\n\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/creditmemos?status=Posted\n\n- /v1/creditmemos?referredInvoiceId=null&status=Draft\n\n- /v1/creditmemos?status=Posted&type=External&sort=+number\n"
      summary: List credit memos
      operationId: GET_CreditMemos
      tags:
      - Credit 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:
              creditmemos:
              - id: 2c92c8f95bd63b94015bd7c39289112e
                number: CM00000002
                accountId: 2c92c8f95bd63b98015bd7ab09ef0926
                accountNumber: A00000001
                currency: USD
                creditMemoDate: '2017-05-05'
                targetDate: null
                postedById: null
                postedOn: null
                status: Draft
                amount: 23
                taxAmount: 0
                totalTaxExemptAmount: 0
                unappliedAmount: 23
                refundAmount: 0
                appliedAmount: 0
                comment: ''
                source: BillRun
                sourceType: Standalone
                sourceId: BR-00000024
                referredInvoiceId: null
                reasonCode: Correcting invoice error
                reversed: false
                createdDate: '2017-05-05 01:39:30'
                createdById: 2c92c8f95b79c9ad015b80614273052c
                updatedDate: '2017-05-05 01:39:30'
                updatedById: 2c92c8f95b79c9ad015b80614273052c
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023
                transferredToAccounting: 'No'
                excludeFromAutoApplyRules: false
                autoApplyUponPosting: false
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                sequenceSetId: null
              - id: 2c92c8f95bd63b9d015bd7ad7fe206f9
                number: CM00000001
                accountId: 2c92c8f95bd63b98015bd7ab09ef0926
                accountNumber: A00000001
                currency: USD
                creditMemoDate: '2017-05-01'
                targetDate: null
                postedById: null
                postedOn: null
                status: Draft
                amount: 10
                taxAmount: 0
                totalTaxExemptAmount: 0
                unappliedAmount: 10
                refundAmount: 0
                appliedAmount: 0
                comment: ''
                source: AdhocFromInvoice
                sourceType: Standalone
                sourceId: null
                referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab
                reasonCode: Correcting invoice error
                reversed: false
                createdDate: '2017-05-05 01:15:23'
                createdById: 2c92c8f95b79c9ad015b80614273052c
                updatedDate: '2017-05-05 01:15:24'
                updatedById: 2c92c8f95b79c9ad015b80614273052c
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d
                transferredToAccounting: 'No'
                excludeFromAutoApplyRules: false
                autoApplyUponPosting: false
                taxStatus: null
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoCollectionType'
      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. \n"
      - name: appliedAmount
        in: query
        type: number
        format: double
        required: false
        description: "This parameter filters the response based on the `appliedAmount` field. \n"
      - name: autoApplyUponPosting
        in: query
        type: boolean
        required: false
        description: "This parameter filters the response based on the `autoApplyUponPosting` field. \n"
      - name: createdById
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `createdById` field. \n"
      - name: createdDate
        in: query
        type: string
        format: date-time
        required: false
        description: "This parameter filters the response based on the `createdDate` field. \n"
      - name: creditMemoDate
        in: query
        type: string
        format: date
        required: false
        description: "This parameter filters the response based on the `creditMemoDate` field. \n"
      - name: currency
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `currency` field. \n"
      - name: excludeFromAutoApplyRules
        in: query
        type: boolean
        required: false
        description: "This parameter filters the response based on the `excludeFromAutoApplyRules` field. \n"
      - name: number
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `number` field. \n"
      - name: referredInvoiceId
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `referredInvoiceId` field. \n"
      - name: refundAmount
        in: query
        type: number
        format: double
        required: false
        description: "This parameter filters the response based on the `refundAmount` field. \n"
      - name: status
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `status` field. \n"
        enum:
        - Draft
        - Posted
        - Canceled
        - Error
        - PendingForTax
        - Generating
        - CancelInProgress
      - name: targetDate
        in: query
        type: string
        format: date
        required: false
        description: "This parameter filters the response based on the `targetDate` field. \n"
      - name: taxAmount
        in: query
        type: number
        format: double
        required: false
        description: "This parameter filters the response based on the `taxAmount` field. \n"
      - name: totalTaxExemptAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `totalTaxExemptAmount` field.

          '
      - name: transferredToAccounting
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `transferredToAccounting` field. \n"
        enum:
        - Processing
        - 'Yes'
        - 'No'
        - Error
        - Ignore
      - name: unappliedAmount
        in: query
        type: number
        format: double
        required: false
        description: "This parameter filters the response based on the `unappliedAmount` field. \n"
      - name: updatedById
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `updatedById` field. \n"
      - 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 credit 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  - accountId\n  - amount\n  - appliedAmount\n  - createdById\n  - createdDate\n  - creditMemoDate\n  - number\n  - referredInvoiceId\n  - refundAmount\n  - status\n  - targetDate\n  - taxAmount\n  - totalTaxExemptAmount\n  - transferredToAccounting\n  - unappliedAmount\n  - updatedDate\n\n  \nExamples:\n\n- /v1/creditmemos?sort=+number\n\n- /v1/creditmemos?status=Processed&sort=-number,+amount\n"
  /v1/creditmemos/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 credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. \n\n- If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices.\n- If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges.\n\nThe credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully. \n\nYou can create credit 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\nZero-amount memo items are supported in the following scenarios:\n- If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.\n- If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.\n"
      summary: Create credit memos
      operationId: POST_CreateCreditMemos
      tags:
      - Credit 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: ff8080817fe9d7b9017fe9e5382f04f5
                number: CM00000001
                accountId: ff8080817fe9d7b9017fe9e5234d04cb
                accountNumber: A00000001
                currency: USD
                creditMemoDate: '2022-04-02'
                targetDate: null
                postedById: null
                postedOn: null
                status: Draft
                amount: 100
                taxAmount: 0
                totalTaxExemptAmount: 0
                unappliedAmount: 100
                refundAmount: 0
                appliedAmount: 0
                comment: test
                source: AdhocFromInvoice
                sourceId: null
                referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0
                reasonCode: Correcting invoice error
                createdDate: '2022-04-02 18:49:47'
                createdById: ff8080817fe9d7b9017fe9e41732030e
                updatedDate: '2022-04-02 18:49:47'
                updatedById: ff8080817fe9d7b9017fe9e41732030e
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: null
                transferredToAccounting: 'No'
                excludeFromAutoApplyRules: false
                autoApplyUponPosting: false
                reversed: false
                taxStatus: null
                sourceType: Invoice
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                sequenceSetId: null
                success: true
              - success: false
                processId: 0356073CB721291A
                reasons:
                - code: 50000040
                  message: Cannot find a Invoice instance with id test.
                objectIndex: 1
          schema:
            $ref: '#/definitions/BulkCreditMemosResponseType'
      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/POSTBulkCreditMemosRequestType'
    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\n  Updates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request.\n  \n  The credit memos that are updated are each in separate database transactions. If the update of one credit memo fails, other credit memos can still be updated successfully. \n  \n  Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items.\n\n  If 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\n  You can update credit 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 credit memos
      operationId: PUT_UpdateCreditMemos
      tags:
      - Credit 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: ff8080817fe9d7b9017fe9e5382f04f5
                number: CM00000001
                accountId: ff8080817fe9d7b9017fe9e5234d04cb
                accountNumber: A00000001
                currency: USD
                creditMemoDate: '2022-04-02'
                targetDate: null
                postedById: null
                postedOn: null
                status: Draft
                amount: 100
                taxAmount: 0
                totalTaxExemptAmount: 0
                unappliedAmount: 100
                refundAmount: 0
                appliedAmount: 0
                comment: test
                source: AdhocFromInvoice
                sourceId: null
                referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0
                reasonCode: Correcting invoice error
                createdDate: '2022-04-02 18:49:47'
                createdById: ff8080817fe9d7b9017fe9e41732030e
                updatedDate: '2022-04-02 18:49:47'
                updatedById: ff8080817fe9d7b9017fe9e41732030e
                cancelledOn: null
                cancelledById: null
                latestPDFFileId: null
                transferredToAccounting: 'No'
                excludeFromAutoApplyRules: false
                autoApplyUponPosting: false
                reversed: false
                taxStatus: null
                sourceType: Invoice
                taxMessage: null
                einvoiceStatus: null
                einvoiceFileId: null
                einvoiceErrorCode: null
                einvoiceErrorMessage: null
                billToContactId: null
                billToContactSnapshotId: null
                sequenceSetId: null
                success: true
              - success: false
                id: ff8080817fe9d7b9017fe9e41732030f
                processId: 0356073CB721291A
                reasons:
                - code: 50000040
                  message: Cannot find a Invoice instance with id.
                objectIndex: 1
          schema:
            $ref: '#/definitions/BulkCreditMemosResponseType'
      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/PUTBulkCreditMemosRequestType'
  /v1/invoices/{invoiceKey}/creditmemos:
    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 credit memo from an invoice.\n\nYou can create a credit 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\nFor a use case of this operation, see [Create credit memo](/rest-api/general-concepts/authentication//#Create-credit-memo).\n\nZero-amount memo items are supported in the following scenarios:\n- If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.\n- If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.\n"
      summary: Create a credit memo from an invoice
      operationId: POST_CreditMemoFromInvoice
      tags:
      - Credit 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: 402890555a87d7f5015a88bd27f80014
              number: CM00000013
              accountId: 402890555a7d4022015a7dabf5f60088
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-11-30'
              targetDate: null
              postedById: null
              postedOn: null
              status: Draft
              amount: 0.01
              taxAmount: 0.01
              totalTaxExemptAmount: 0
              unappliedAmount: 0.01
              refundAmount: 0
              appliedAmount: 0
              comment: the comment
              source: AdhocFromInvoice
              sourceType: Invoice
              sourceId: null
              referredInvoiceId: 402890555a7d4022015a7dadb3b300a4
              reasonCode: Write-off
              reversed: false
              createdDate: '2017-03-01 15:19:42'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 15:19:42'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: null
              excludeItemBillingFromRevenueAccounting: true
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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* `items` > `comment`\n* `items` > `description`\n"
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/CreditMemoFromInvoiceType'
      - type: string
        in: path
        description: 'The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.

          '
        name: invoiceKey
        required: true
  /v1/creditmemos/{creditMemoKey}:
    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 credit memo.\n\nFor a use case of this operation, see [Get credit memo](/rest-api/general-concepts/authentication//#Get-credit-memo).\n"
      summary: Retrieve a credit memo
      operationId: GET_CreditMemo
      tags:
      - Credit 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: 402890555a7e9791015a879f064a0054
              number: CM00000012
              accountId: 402890555a7e9791015a7f15fe44001c
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-01'
              targetDate: null
              postedById: null
              postedOn: null
              status: Draft
              amount: 3.1
              taxAmount: 0.1
              totalTaxExemptAmount: 0
              unappliedAmount: 3.1
              refundAmount: 0
              appliedAmount: 0
              comment: ''
              source: API
              sourceType: Standalone
              sourceId: null
              referredInvoiceId: 402890555a7e9791015a7f1756aa0035
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-01 10:07:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 10:08:43'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: 402890555a7e9791015a879f07fb005e
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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 credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        name: creditMemoKey
        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 credit 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 credit 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 credit memo
      operationId: PUT_UpdateCreditMemo
      tags:
      - Credit 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: 4028905f5a890526015a8d73f73d0015
              number: CM00000001
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-02'
              targetDate: null
              postedById: null
              postedOn: null
              status: Draft
              amount: 10.76
              taxAmount: 0.76
              totalTaxExemptAmount: 0
              unappliedAmount: 10.76
              refundAmount: 0
              appliedAmount: 0
              comment: ''
              source: AdhocFromPrpc
              sourceId: null
              sourceType: Standalone
              referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-02 13:17:51'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-02 13:19:00'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: 4028905f5a890526015a8d7408730024
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: true
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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/PUTCreditMemoType'
      - type: string
        in: path
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        name: creditMemoKey
        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 credit memo. Only credit memos with the Cancelled status can be deleted. \n\nYou can delete a credit 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 credit memo
      operationId: DELETE_CreditMemo
      tags:
      - Credit 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
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/apply:
    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\nApplies a posted credit memo to one or more invoices and debit memos. \n\nYou can apply a credit memo to an invoice or 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\nWhen you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000.\n\nIf the limit is hit, you can follow the following instructions:\n\n- If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000.\n- If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000.\n        \nIf the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 15,000: \n\n(number of invoice items + number of debit memo items) * number of credit memo items\n\nOtherwise, the First In First Out rule will be used instead of the Proration rule.\n"
      summary: Apply a credit memo
      operationId: PUT_ApplyCreditMemo
      tags:
      - Credit 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: 4028905f5a890526015a8d73f73d0015
              number: CM00000001
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-02'
              targetDate: null
              postedById: 402881e522cf4f9b0122cf5d82860002
              postedOn: '2017-03-02 13:21:55'
              status: Posted
              amount: 10.76
              taxAmount: 0.76
              totalTaxExemptAmount: 0
              unappliedAmount: 2.66
              refundAmount: 7.1
              appliedAmount: 1
              comment: ''
              source: AdhocFromPrpc
              sourceId: null
              sourceType: Standalone
              referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-02 13:17:51'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-02 13:25:29'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: 4028905f5a890526015a8d77af600036
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: true
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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/ApplyCreditMemoType'
      - type: string
        in: path
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/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 credit memo. Only credit memos with the Draft status can be cancelled. \n\nYou can cancel a credit 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 credit memo
      operationId: PUT_CancelCreditMemo
      tags:
      - Credit 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: 402890555a87d7f5015a88c7a6830022
              number: CM00000015
              accountId: 402890555a7e9791015a7f15fe44001c
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-10-17'
              targetDate: null
              postedById: null
              postedOn: null
              status: Canceled
              amount: 2020
              taxAmount: 0
              totalTaxExemptAmount: 0
              unappliedAmount: 2020
              refundAmount: 0
              appliedAmount: 0
              comment: the comment
              source: AdhocFromPrpc
              sourceId: null
              sourceType: Standalone
              referredInvoiceId: null
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-01 15:31:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 15:36:57'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: '2017-09-03 19:59:07'
              cancelledById: 402881e522cf4f9b0122cf5d82860002
              latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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 credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        name: creditMemoKey
        required: true
  /v1/creditmemos/{creditMemoKey}/emails:
    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\nSends a posted credit memo to the specified email addresses manually.\n\n\n\n### Notes\n  - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit 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 Credit 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 credit 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"
      summary: Email a credit memo
      operationId: POST_EmailCreditMemo
      tags:
      - Credit 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/PostCreditMemoEmailRequestType'
      - name: creditMemoKey
        type: string
        in: path
        required: true
        description: 'The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
  /v1/creditmemos/{creditMemoKey}/files:
    post:
      summary: Upload a file for a credit memo
      operationId: POST_UploadFileForCreditMemo
      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 credit memo that is in Draft or Posted status.\n\nTo use this operation, you must enable the Modify Modify Credit 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 credit memo.\n"
      consumes:
      - multipart/form-data
      tags:
      - Credit 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: creditMemoKey
        in: path
        description: 'The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001.

          '
        required: true
        type: string
      - name: file
        in: formData
        description: 'The PDF file to upload for the credit 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: 40289f466463d683016463ef8b7301a4
          description: ''
          schema:
            $ref: '#/definitions/POSTUploadFileResponse'
      x-code-samples:
      - lang: curl
        label: Curl
        source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/creditmemos/402890555a7e9791015a879f064a0054/files"

          '
  /v1/creditmemos/{creditMemoKey}/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 credit memo. A credit memo item is a single line item in a credit 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/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100\n  \n  - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n    \n"
      summary: List credit memo items
      operationId: GET_CreditMemoItems
      tags:
      - Credit 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: 402890555a7e9791015a879f064d0055
                amount: 1
                amountWithoutTax: 0
                appliedAmount: 0
                appliedToItemId: null
                refundAmount: 0
                unappliedAmount: 1
                comment: ''
                taxMode: TaxExclusive
                processingType: Charge
                quantity: 1
                sku: SKU-00000001
                skuName: New Component
                serviceStartDate: '2017-02-27'
                serviceEndDate: '2017-03-26'
                sourceItemType: InvoiceDetail
                sourceItemId: 402890555a7e9791015a7f1756bc0037
                creditFromItemSource: CreditMemoItem
                creditFromItemId: 402880e97a56f30b017a574012e50085
                excludeItemBillingFromRevenueAccounting: true
                createdDate: '2017-03-01 10:07:10'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:08:43'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                subscriptionId: 402890d25bec1155015bec35cc7c0bc7
                unitOfMeasure: Each
                unitPrice: 1
                soldToContactId: 402881e522cf4f9b0122cf5d82860003
                soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                numberOfDeliveries: 1
                financeInformation:
                  onAccountAccountingCode: null
                  onAccountAccountingCodeType: null
                  deferredRevenueAccountingCode: null
                  deferredRevenueAccountingCodeType: null
                  recognizedRevenueAccountingCode: null
                  recognizedRevenueAccountingCodeType: null
                taxationItems:
                  data:
                  - id: 402890555a7e9791015a87a072880062
                    sourceTaxItemId: null
                    taxAmount: 0.1
                    appliedAmount: 0
                    unappliedAmount: 0.1
                    refundAmount: 0
                    name: STATE TAX
                    exemptAmount: 0
                    jurisdiction: CALIFORNIA
                    locationCode: '06'
                    taxCode: ServiceTaxCode
                    taxCodeDescription: This is tax code description!
                    taxDate: '2016-09-30'
                    taxRate: 0.0625
                    taxRateDescription: This is tax rate description!
                    taxRateType: Percentage
                    financeInformation:
                      onAccountAccountingCode: Check
                      onAccountAccountingCodeType: Cash
                      salesTaxPayableAccountingCode: Check
                      salesTaxPayableAccountingCodeType: Cash
              - id: 402890555a7e9791015a879f06610056
                amount: 2
                amountWithoutTax: 2
                appliedAmount: 0
                appliedToItemId: null
                refundAmount: 0
                unappliedAmount: 2
                comment: ''
                taxMode: TaxExclusive
                processingType: Charge
                quantity: 1
                sku: SKU-00000001
                skuName: New Component
                serviceStartDate: '2017-02-27'
                serviceEndDate: '2017-03-26'
                sourceItemType: InvoiceDetail
                sourceItemId: 402890555a7e9791015a7f1756bd0038
                excludeItemBillingFromRevenueAccounting: true
                creditFromItemSource: CreditMemoItem
                creditFromItemId: 402880e97a56f30b017a574012f00086
                createdDate: '2017-03-01 10:07:10'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:07:10'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                subscriptionId: 402890d25bec1155015bec35cc7c0bc7
                unitOfMeasure: Each
                unitPrice: 2
                soldToContactId: 402881e522cf4f9b0122cf5d82860003
                soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                numberOfDeliveries: 1
                financeInformation:
                  onAccountAccountingCode: null
                  onAccountAccountingCodeType: null
                  deferredRevenueAccountingCode: null
                  deferredRevenueAccountingCodeType: null
                  recognizedRevenueAccountingCode: null
                  recognizedRevenueAccountingCodeType: null
                taxationItems:
                  data: []
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoItemsListType'
      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
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        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` > `creditTaxItems`\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. \n"
      - name: appliedAmount
        in: query
        type: number
        format: double
        required: false
        description: 'This parameter filters the response based on the `appliedAmount` field.

          '
      - name: createdById
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `createdById` field. \n"
      - name: createdDate
        in: query
        type: string
        format: date-time
        required: false
        description: "This parameter filters the response based on the `createdDate` field. \n"
      - name: id
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `id` field. \n"
      - name: refundAmount
        in: query
        type: number
        format: double
        required: false
        description: "This parameter filters the response based on the `refundAmount` field. \n"
      - name: serviceEndDate
        in: query
        type: string
        format: date
        required: false
        description: "This parameter filters the response based on the `serviceEndDate` field. \n"
      - name: serviceStartDate
        in: query
        type: string
        format: date
        required: false
        description: "This parameter filters the response based on the `serviceStartDate` field. \n"
      - name: sku
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `sku` field. \n"
      - name: skuName
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `skuName` field. \n"
      - name: sourceItemId
        in: query
        type: string
        required: false
        description: "This parameter filters the response based on the `sourceItemId` field. \n"
      - 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. \n"
      - 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  - amount\n  - appliedAmount\n  - createdById\n  - createdDate\n  - id\n  - refundAmount\n  - serviceEndDate\n  - serviceStartDate\n  - sku\n  - skuName\n  - sourceItemId\n  - subscriptionId\n  - updatedById\n  - updatedDate\n  \nExamples:\n\n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate\n\n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n"
  /v1/creditmemos/{creditMemoKey}/items/{cmitemid}:
    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 the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo.

        '
      summary: Retrieve a credit memo item
      operationId: GET_CreditMemoItem
      tags:
      - Credit 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: 402890555a7e9791015a879f064d0055
              amount: 1
              amountWithoutTax: 1
              appliedAmount: 0
              appliedToItemId: null
              refundAmount: 0
              unappliedAmount: 1
              comment: ''
              taxMode: TaxExclusive
              processingType: Charge
              quantity: 1
              sku: SKU-00000001
              skuName: New Component
              serviceStartDate: '2017-02-27'
              serviceEndDate: '2017-03-26'
              sourceItemType: InvoiceDetail
              sourceItemId: 402890555a7e9791015a7f1756bc0037
              creditFromItemSource: CreditMemoItem
              creditFromItemId: 402880e97a56f30b017a574012f00086
              createdDate: '2017-03-01 10:07:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 10:08:43'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              excludeItemBillingFromRevenueAccounting: true
              subscriptionId: 402890d25bec1155015bec35cc7c0bc7
              unitOfMeasure: Each
              unitPrice: 1
              soldToContactId: 402881e522cf4f9b0122cf5d82860003
              soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
              invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
              invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
              numberOfDeliveries: 1
              financeInformation:
                onAccountAccountingCode: null
                onAccountAccountingCodeType: null
                deferredRevenueAccountingCode: null
                deferredRevenueAccountingCodeType: null
                recognizedRevenueAccountingCode: null
                recognizedRevenueAccountingCodeType: null
              taxationItems:
                data: []
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoItemType'
      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
        name: cmitemid
        description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](/api-references/api/operation/GET_CreditMemoItems).

          '
        required: true
      - type: string
        in: path
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        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* `creditTaxItems`\n* `taxationItems`\n* `comment`\n* `description`\n"
  /v1/creditmemos/{creditMemoId}/items/{cmitemid}/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.\n\nRetrieves information about the taxation items of a specific credit memo item. \n"
      summary: List all taxation items of a credit memo item
      operationId: GET_TaxationItemsOfCreditMemoItem
      tags:
      - Credit 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:
              - sourceTaxItemId: null
                appliedAmount: 0
                unappliedAmount: 10
                refundAmount: 0
                financeInformation:
                  onAccountAccountingCode: null
                  onAccountAccountingCodeType: null
                  salesTaxPayableAccountingCode: null
                  salesTaxPayableAccountingCodeType: null
                id: 2c98901a68ff2680016903216a271a67
                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/GETTaxationItemsOfCreditMemoItemType'
      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
        name: cmitemid
        description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](/api-references/api/operation/GET_CreditMemoItems).

          '
        required: true
      - type: string
        in: path
        name: creditMemoId
        description: 'The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/parts:
    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 parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part.\n"
      summary: List all parts of a credit memo
      operationId: GET_CreditMemoParts
      tags:
      - Credit 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:
              parts:
              - id: 4028905f5a890526015a8d77adea0029
                invoiceId: null
                debitMemoId: null
                amount: 3.66
                createdDate: '2017-03-02 13:21:55'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-02 13:21:55'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoPartsCollectionType'
      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
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/parts/{partid}:
    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 credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos.\n\nA fully refunded credit memo does not contain any credit memo part.\n"
      summary: Retrieve a credit memo part
      operationId: GET_CreditMemoPart
      tags:
      - Credit 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: 4028905f5a890526015a8d9adeb30059
              invoiceId: 4028905f5a87c0ff015a87d3f8f10043
              debitMemoId: null
              amount: 1
              createdDate: '2017-03-02 14:00:21'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-02 14:00:21'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoPartType'
      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
        name: partid
        description: 'The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](/api-references/api/operation/GET_CreditMemoParts).

          '
        required: true
      - type: string
        in: path
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/pdfs:
    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 a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit memo page through the Zuora UI.\n\nThis REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled.\n"
      summary: Generate a credit memo PDF file
      operationId: POST_CreditMemoPDF
      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: creditMemoKey
        in: path
        description: 'The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        required: true
        type: string
      tags:
      - Credit 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/creditmemos/{creditMemoKey}/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 credit memo to activate it. You can post credit 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 credit memo
      operationId: PUT_PostCreditMemo
      tags:
      - Credit 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: 402890555a7e9791015a879f064a0054
              number: CM00000012
              accountId: 402890555a7e9791015a7f15fe44001c
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-01'
              targetDate: null
              postedById: 402881e522cf4f9b0122cf5d82860002
              postedOn: '2017-03-01 14:28:06'
              status: Posted
              amount: 3.1
              taxAmount: 0.1
              totalTaxExemptAmount: 0
              unappliedAmount: 3.1
              refundAmount: 0
              appliedAmount: 0
              comment: ''
              source: API
              sourceId: null
              sourceType: Standalone
              referredInvoiceId: 402890555a7e9791015a7f1756aa0035
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-01 10:07:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:28:06'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: null
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/refunds:
    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\nRefunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. \n\nYou can refund a credit 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\nWhen you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000.\n\nFor a use case of this operation, see [Refund processing](/rest-api/general-concepts/authentication//#Refund-processing).\n"
      summary: Refund a credit memo
      operationId: POST_RefundCreditMemo
      tags:
      - Credit 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: 4028905f5a890526015a8d7af4280039
              number: R-00000002
              status: Processed
              type: External
              methodType: CreditCard
              accountId: 4028905f5a87c0ff015a87d25ae90025
              amount: 7.1
              refundDate: '2017-03-02'
              comment: null
              paymentMethodId: null
              paymentMethodSnapshotId: null
              paymentId: null
              creditMemoId: 4028905f5a890526015a8d73f73d0015
              reasonCode: Standard Refund
              gatewayId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondRefundReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-02 13:25:29'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-02 13:25:29'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              refundTransactionTime: null
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                onAccountAccountingCode: null
                onAccountAccountingCodeType: null
                transferredToAccounting: 'No'
              success: true
          schema:
            $ref: '#/definitions/GETRefundCreditMemoType'
      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/PostNonRefRefundType'
      - type: string
        in: path
        name: creditMemoKey
        description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/reverse:
    put:
      summary: Reverse a credit memo
      operationId: PUT_ReverseCreditMemo
      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.


        Reverses a posted credit memo. See [Reverse credit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos) for more information.


        You can reverse a credit 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.


        **Restrictions**


        You cannot reverse credit memos if any of the following conditions is met:


        * A credit memo''s applied amount is not 0.

        * A credit memo is not in Posted status.

        * A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items.

        '
      tags:
      - Credit 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: creditMemoKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.

          '
      - name: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PutReverseCreditMemoType'
      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:
              debitMemo:
                id: 402890555a40ca7f015a5b099b0e307a
              success: true
          description: ''
          schema:
            $ref: '#/definitions/PutReverseCreditMemoResponseType'
  /v1/creditmemos/{creditMemoKey}/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 credit memo.

        '
      summary: Create taxation items for a credit memo
      operationId: POST_CM_TaxationItems
      tags:
      - Credit 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:08:43'
                exemptAmount: 0
                id: 402890555a7e9791015a87a072880062
                memoItemId: 402890555a7e9791015a879f064d0055
                sourceTaxItemId: 402890555a7d4022015a7db254e200c1
                jurisdiction: CALIFORNIA
                locationCode: '06'
                name: STATE TAX
                taxAmount: 0.1
                taxCode: ServiceTaxCode
                taxCodeDescription: This is tax code description!
                taxDate: '2016-09-30'
                taxRate: 0.0625
                taxRateDescription: This is tax rate description!
                taxRateType: Percentage
                updatedById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 10:08:43'
                financeInformation:
                  onAccountAccountingCode: Check
                  onAccountAccountingCodeType: Cash
                  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: creditMemoKey
        required: true
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/POSTTaxationItemListForCMType'
  /v1/creditmemos/{creditMemoKey}/unapply:
    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\nUnapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. \n\nYou can unapply a credit memo from an invoice or 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\nWhen you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000.\n\nIf the limit is hit, you can follow the following instructions:\n\n- If you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items.\n- If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000.\n- If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000.\n\n\nIf the Proration application rule is used, when unapplying credit memos, the following quantity must be less than or equal to 15,000: \n\n(number of invoice items + number of debit memo items) * number of credit memo items\n\nOtherwise, the First In First Out rule will be used instead of the Proration rule.\n"
      summary: Unapply a credit memo
      operationId: PUT_UnapplyCreditMemo
      tags:
      - Credit 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: 4028905f5a890526015a8d73f73d0015
              number: CM00000001
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-02'
              targetDate: null
              postedById: 402881e522cf4f9b0122cf5d82860002
              postedOn: '2017-03-02 13:21:55'
              status: Posted
              amount: 10.76
              taxAmount: 0.76
              sourceType: Standalone
              totalTaxExemptAmount: 0
              unappliedAmount: 3.66
              refundAmount: 7.1
              appliedAmount: 0
              comment: ''
              source: AdhocFromPrpc
              sourceId: null
              referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-02 13:17:51'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-02 13:25:29'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: 4028905f5a890526015a8d77af600036
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: true
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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/UnapplyCreditMemoType'
      - type: string
        in: path
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
  /v1/creditmemos/{creditMemoKey}/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 credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. \n\nYou can unpost credit 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 credit memo
      operationId: PUT_UnpostCreditMemo
      tags:
      - Credit 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: 402890555a7e9791015a879f064a0054
              number: CM00000012
              accountId: 402890555a7e9791015a7f15fe44001c
              accountNumber: A00000001
              currency: USD
              creditMemoDate: '2017-03-01'
              targetDate: null
              postedById: 402881e522cf4f9b0122cf5d82860002
              postedOn: '2017-03-01 14:28:06'
              status: Draft
              amount: 3.1
              taxAmount: 0.1
              totalTaxExemptAmount: 0
              unappliedAmount: 3.1
              refundAmount: 0
              appliedAmount: 0
              comment: ''
              source: API
              sourceId: null
              sourceType: Standalone
              referredInvoiceId: 402890555a7e9791015a7f1756aa0035
              reasonCode: Correcting invoice error
              reversed: false
              createdDate: '2017-03-01 10:07:10'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:28:06'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              cancelledOn: null
              cancelledById: null
              latestPDFFileId: null
              transferredToAccounting: 'No'
              excludeFromAutoApplyRules: false
              autoApplyUponPosting: false
              taxStatus: null
              taxMessage: null
              einvoiceStatus: null
              einvoiceFileId: null
              einvoiceErrorCode: null
              einvoiceErrorMessage: null
              billToContactId: null
              billToContactSnapshotId: null
              sequenceSetId: null
              success: true
          schema:
            $ref: '#/definitions/GETCreditMemoType'
      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
        name: creditMemoKey
        description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.

          '
        required: true
  /v1/creditmemos/{creditMemoId}/write-off:
    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\nWrite off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo.\n\nNote that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation. \n"
      summary: Write off a credit memo
      operationId: PUT_WriteOffCreditMemo
      tags:
      - Credit 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:
              debitMemo:
                id: 4028905f5a87c0ff015a87e49e6b0062
              success: true
          schema:
            $ref: '#/definitions/PUTCreditMemoWriteOffResponseType'
      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
        name: creditMemoId
        description: 'The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

          '
        required: true
      - name: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PUTCreditMemoWriteOff'
  /v1/creditmemos/{creditMemoKey}/einvoice/generate:
    put:
      summary: Generate an e-invoice file for a credit memo
      operationId: PUT_GenerateEInvoiceFileForCreditMemo
      description: 'Generates an e-invoice file for a credit 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:
      - Credit 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: creditMemoKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-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:
  CreditMemoApplyInvoiceItemRequestType:
    properties:
      amount:
        description: "The amount that is applied to the specific item. \n"
        format: double
        type: number
      creditMemoItemId:
        description: 'The ID of the credit memo item.

          '
        type: string
      creditTaxItemId:
        description: 'The ID of the credit memo taxation item.

          '
        type: string
      invoiceItemId:
        description: 'The ID of the invoice item that the credit memo item is applied to.

          '
        type: string
      taxItemId:
        description: 'The ID of the invoice taxation item that the credit memo taxation item is applied to.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PUTCreditMemosWithIdType:
    allOf:
    - properties:
        id:
          description: 'The ID of the credit memo.

            '
          type: string
      type: object
    - $ref: '#/definitions/PUTCreditMemoType'
    title: memos
  CreditMemoApplyDebitMemoItemRequestType:
    properties:
      amount:
        description: "The amount that is applied to the specific item. \n"
        format: double
        type: number
      creditMemoItemId:
        description: 'The ID of the credit memo item.

          '
        type: string
      creditTaxItemId:
        description: 'The ID of the credit memo taxation item.

          '
        type: string
      debitMemoItemId:
        description: 'The ID of the debit memo item that the credit memo item is applied to.

          '
        type: string
      taxItemId:
        description: 'The ID of the debit memo taxation item that the credit memo taxation item is applied to.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PutReverseCreditMemoType:
    example:
      applyEffectiveDate: '2017-02-20'
      memoDate: '2017-02-20'
    properties:
      applyEffectiveDate:
        description: 'The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date.


          The default value is the date when you reverse the credit memo and create the debit memo.

          '
        format: date
        type: string
      memoDate:
        description: 'The date when the debit memo is created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the credit memo''s memo date.


          The default value is the date when you reverse the credit memo and create the debit memo.

          '
        format: date
        type: string
    type: object
  CreditMemoUnapplyInvoiceRequestType:
    properties:
      amount:
        description: 'The credit memo amount to be unapplied from the invoice.

          '
        format: double
        type: number
      invoiceId:
        description: 'The unique ID of the invoice that the credit memo is unapplied from.

          '
        type: string
      items:
        description: 'Container for items. The maximum number of items is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoUnapplyInvoiceItemRequestType'
        type: array
    required:
    - amount
    - invoiceId
    title: invoices
    type: object
  GETCreditMemoType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the credit memo.

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

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

            '
          format: double
          type: number
        appliedAmount:
          description: 'The applied amount of the credit memo.

            '
          format: double
          type: number
        autoApplyUponPosting:
          description: 'Whether the credit memo automatically applies to the invoice upon posting.

            '
          type: boolean
        billToContactId:
          description: 'The ID of the bill-to contact associated with the credit 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 credit 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 credit memo.

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

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

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

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

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

            '
          format: date
          type: string
        currency:
          description: 'A currency defined in the web-based UI administrative settings.

            '
          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 credit 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 credit 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
        excludeFromAutoApplyRules:
          description: 'Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.

            '
          type: boolean
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the credit 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 credit memo.

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

            '
          type: string
        number:
          description: 'The unique identification number of the credit 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
        postedById:
          description: 'The ID of the Zuora user who posted the credit memo.

            '
          type: string
        postedOn:
          description: 'The date and time when the credit 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
        referredInvoiceId:
          description: 'The ID of a referred invoice.

            '
          type: string
        refundAmount:
          description: 'The amount of the refund on the credit memo.

            '
          format: double
          type: number
        reversed:
          description: 'Whether the credit memo is reversed.

            '
          type: boolean
        sequenceSetId:
          description: 'The ID of the sequence set associated with the credit 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
        source:
          description: 'The source of the credit memo.


            Possible values:

            - `BillRun`: The credit memo is generated by a bill run.

            - `API`: The credit memo is created by calling the [Invoice and collect](/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.

            - `ApiSubscribe`: The credit memo is created by calling the [Create subscription](/v1-api-reference/api/subscriptions/post_subscription) and [Create account](/v1-api-reference/api/accounts/post_account) operation.

            - `ApiAmend`: The credit memo is created by calling the [Update subscription](/v1-api-reference/api/subscriptions/put_subscription) operation.

            - `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](/api-references/api/operation/POST_CreditMemoFromPrpc) operation.

            - `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](/api-references/api/operation/PUT_ReverseInvoice) operation.

            '
          type: string
        sourceId:
          description: 'The ID of the credit memo source.


            If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`.

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

            '
          enum:
          - Subscription
          - Standalone
          - Invoice
          - Order
          - CreditMemo
          - Consolidation
          type: string
        status:
          description: 'The status of the credit 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 credit 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 credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.

            '
          type: string
        taxStatus:
          description: 'The status of tax calculation related to the credit 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 credit 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
        unappliedAmount:
          description: 'The unapplied amount of the credit memo.

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

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

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/CreditMemoObjectNSFields'
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
  PostCreditMemoEmailRequestType:
    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 credit 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 credit 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 credit memo is sent in the email.\n"
        type: string
      useEmailTemplateSetting:
        default: false
        description: "Indicates whether to email a credit memo based on the email template setting. \n\nIf you set this field to `true`, the credit 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
  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
  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
  GETCreditMemoCollectionType:
    properties:
      creditmemos:
        description: 'Container for credit memos.

          '
        items:
          $ref: '#/definitions/GETCreditMemoTypewithSuccess'
        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
  PostNonRefRefundType:
    allOf:
    - properties:
        comment:
          description: 'Comments about the refund.

            '
          maxLength: 255
          minLength: 0
          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, Reporting currency item, or both).


            **Note**: The API custom rate feature is permission controlled.

            '
          items:
            $ref: '#/definitions/CreditMemoFromChargeCustomRatesType'
          maxItems: 2
          type: array
        financeInformation:
          description: 'Container for the finance information related to the refund.

            '
          properties:
            bankAccountAccountingCode:
              description: 'The accounting code that maps to a bank account in your accounting system.

                '
              maxLength: 100
              minLength: 0
              type: string
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              maxLength: 100
              minLength: 0
              type: string
            transferredToAccounting:
              description: "Whether the refund 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
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        gatewayId:
          description: "The ID of the gateway instance that processes the refund. This field can be specified only for electronic refunds. The ID must be a valid gateway instance ID, and this gateway must support the specific payment method. \n\nIf no gateway ID is specified, the default gateway in the billing account configuration will be used. If no gateway is specified in the billing account, the default gateway of the corresponding tenant will be used.\n"
          type: string
        gatewayOptions:
          description: 'The field used to pass gateway-specific parameters and parameter values.

            '
          properties:
            key:
              description: 'The name of a gateway-specific parameter.

                '
              type: string
            value:
              description: 'The value of the gateway-specific parameter.

                '
              type: string
          type: object
        items:
          description: 'Container for credit memo items. The maximum number of items is 1,000.


            **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish 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.

            '
          items:
            $ref: '#/definitions/RefundCreditMemoItemType'
          type: array
        methodType:
          description: 'How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on a credit memo.

            '
          enum:
          - ACH
          - Cash
          - Check
          - CreditCard
          - PayPal
          - WireTransfer
          - DebitCard
          - CreditCardReferenceTransaction
          - BankTransfer
          - Other
          type: string
        paymentMethodId:
          description: "The ID of the payment method used for the refund. This field is required for an electronic refund, and the value must be an electronic payment method ID. This field must be left empty for an external refund. \n"
          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
        referenceId:
          description: 'The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

            '
          maxLength: 100
          minLength: 0
          type: string
        refundDate:
          description: 'The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the credit memo date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds.

            '
          format: date
          type: string
        secondRefundReferenceId:
          description: 'The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          maxLength: 100
          minLength: 0
          type: string
        softDescriptor:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 35
          type: string
        softDescriptorPhone:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 20
          type: string
        totalAmount:
          description: 'The total amount of the refund. The amount cannot exceed the unapplied amount of the associated credit memo. If the original credit memo was applied to one or more invoices or debit memos, you have to unapply a full or partial credit memo from the invoices or debit memos, and then refund the full or partial unapplied credit memo to your customers.

            '
          format: double
          type: number
        type:
          description: 'The type of the refund.

            '
          enum:
          - External
          - Electronic
          type: string
      required:
      - totalAmount
      - type
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
    example:
      customRates:
      - currency: CAD
        customFxRate: 2.22
        rateDate: '2022-10-21'
      - currency: EUR
        customFxRate: 1.5
        rateDate: '2022-10-21'
      gatewayOptions:
        Comments: test
        IPAddress: 192.168.1.1
      items:
      - amount: 7
        creditMemoItemId: 4028905f5a890526015a8d73f74b0016
      - amount: 0.1
        creditTaxItemId: 4028905f5a890526015a8d73f90c0018
      methodType: CreditCard
      refundDate: '2017-03-02'
      totalAmount: 7.1
      type: External
  CreditMemoObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Credit 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 Credit Memo object.

      '
    title: creditMemoFieldsCustom
    type: object
  RefundObjectNSFields:
    description: 'Container for Refund 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 refund''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
      Origin__NS:
        description: 'Origin 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
      SyncDate__NS:
        description: 'Date when the refund 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
      SynctoNetSuite__NS:
        description: 'Specifies whether the refund should be 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: refundFieldsNS
    type: object
  CreditMemoItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Credit 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 Credit Memo Item object.

      '
    title: creditMemoItemFieldsCustom
    type: object
  GETCreditMemoPartsCollectionType:
    properties:
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      parts:
        description: 'Container for credit memo parts.

          '
        items:
          $ref: '#/definitions/GETCreditMemoPartTypewithSuccess'
        type: array
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  GETCreditMemoTypewithSuccess:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the credit memo.

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

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

            '
          format: double
          type: number
        appliedAmount:
          description: 'The applied amount of the credit memo.

            '
          format: double
          type: number
        autoApplyUponPosting:
          description: 'Whether the credit memo automatically applies to the invoice upon posting.

            '
          type: boolean
        billToContactId:
          description: 'The ID of the bill-to contact associated with the credit 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 credit memo.

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

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

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

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

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

            '
          format: date
          type: string
        currency:
          description: 'A currency defined in the web-based UI administrative settings.

            '
          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 credit 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 credit 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
        excludeFromAutoApplyRules:
          description: 'Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs.

            '
          type: boolean
        id:
          description: 'The unique ID of the credit memo.

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

            '
          type: string
        number:
          description: 'The unique identification number of the credit 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
        postedById:
          description: 'The ID of the Zuora user who posted the credit memo.

            '
          type: string
        postedOn:
          description: 'The date and time when the credit 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
        referredInvoiceId:
          description: 'The ID of a referred invoice.

            '
          type: string
        refundAmount:
          description: 'The amount of the refund on the credit memo.

            '
          format: double
          type: number
        reversed:
          description: 'Whether the credit memo is reversed.

            '
          type: boolean
        sequenceSetId:
          description: 'The ID of the sequence set associated with the credit 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
        source:
          description: 'The source of the credit memo.


            Possible values:

            - `BillRun`: The credit memo is generated by a bill run.

            - `API`: The credit memo is created by calling the [Invoice and collect](/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations.

            - `ApiSubscribe`: The credit memo is created by calling the [Create subscription](/v1-api-reference/api/subscriptions/post_subscription) and [Create account](/v1-api-reference/api/accounts/post_account) operation.

            - `ApiAmend`: The credit memo is created by calling the [Update subscription](/v1-api-reference/api/subscriptions/put_subscription) operation.

            - `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](/api-references/api/operation/POST_CreditMemoFromPrpc) operation.

            - `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](/api-references/api/operation/PUT_ReverseInvoice) operation.

            '
          type: string
        sourceId:
          description: "The ID of the credit memo source. \n\nIf a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`.\n"
          type: string
        sourceType:
          description: 'The type of the credit memo source.

            '
          enum:
          - Subscription
          - Standalone
          - Invoice
          - Order
          - CreditMemo
          - Consolidation
          type: string
        status:
          description: "The status of the credit memo. \n"
          enum:
          - Draft
          - Posted
          - Canceled
          - Error
          - PendingForTax
          - Generating
          - CancelInProgress
          type: string
        targetDate:
          description: 'The target date for the credit 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 credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure.

            '
          type: string
        taxStatus:
          description: 'The status of tax calculation related to the credit 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 credit 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
        unappliedAmount:
          description: 'The unapplied amount of the credit memo.

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the credit 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/CreditMemoObjectNSFields'
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
    title: creditmemos
  CreditMemoUnapplyDebitMemoItemRequestType:
    properties:
      amount:
        description: "The amount that is unapplied from the specific item. \n"
        format: double
        type: number
      creditMemoItemId:
        description: 'The ID of the credit memo item.

          '
        type: string
      creditTaxItemId:
        description: 'The ID of the credit memo taxation item.

          '
        type: string
      debitMemoItemId:
        description: 'The ID of the debit memo item that the credit memo item is unapplied from.

          '
        type: string
      taxItemId:
        description: 'The ID of the debit memo taxation item that the credit memo taxation item is unapplied from.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  GETCreditMemoPartType:
    properties:
      amount:
        description: 'The amount of the credit memo part.

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

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

          '
        format: date-time
        type: string
      debitMemoId:
        description: 'The ID of the debit memo associated with the credit memo part.

          '
        type: string
      id:
        description: 'The ID of the credit memo part.

          '
        type: string
      invoiceId:
        description: 'The ID of the invoice associated with the credit memo part.

          '
        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
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
      updatedById:
        description: 'The ID of the Zuora user who last updated the credit memo part.

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

          '
        format: date-time
        type: string
    type: object
  DebitMemoObjectCustomFieldsCMWriteOff:
    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
  CreditMemoFromChargeCustomRatesType:
    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/Reporting 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/CreditMemoItemObjectCustomFields'
    title: customRates
  CreditMemoUnapplyInvoiceItemRequestType:
    properties:
      amount:
        description: "The amount that is unapplied from the specific item. \n"
        format: double
        type: number
      creditMemoItemId:
        description: 'The ID of the credit memo item.

          '
        type: string
      creditTaxItemId:
        description: 'The ID of the credit memo taxation item.

          '
        type: string
      invoiceItemId:
        description: 'The ID of the invoice item that the credit memo item is unapplied from.

          '
        type: string
      taxItemId:
        description: 'The ID of the invoice taxation item that the credit memo taxation item is unapplied from.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  GETCreditMemoItemsListType:
    properties:
      items:
        description: 'Container for credit memo items.

          '
        items:
          $ref: '#/definitions/GETCreditMemoItemTypewithSuccess'
        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
  PUTCreditMemoType:
    allOf:
    - properties:
        autoApplyUponPosting:
          description: 'Whether the credit memo automatically applies to the invoice upon posting.

            '
          type: boolean
        comment:
          description: 'Comments about the credit memo.

            '
          maxLength: 255
          minLength: 0
          type: string
        effectiveDate:
          description: 'The date when the credit memo takes effect.

            '
          format: date
          type: string
        excludeFromAutoApplyRules:
          description: 'Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos.

            '
          type: boolean
        items:
          description: 'Container for credit memo items.

            '
          items:
            $ref: '#/definitions/PUTCreditMemoItemType'
          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 credit 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/CreditMemoObjectNSFields'
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
    example:
      autoApplyUponPosting: false
      comment: new comment
      effectiveDate: '2017-04-17'
      excludeFromAutoApplyRules: false
      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
  POSTTaxationItemForCMType:
    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:
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              maxLength: 100
              minLength: 0
              type: string
            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 credit 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 credit memo is created from. \n\nIf you want to use this REST API to create taxation items for a credit 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 credit 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 credit memo.

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

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

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

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the credit 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 credit memo.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - taxRate
      - jurisdiction
      - name
      - taxRateType
      - taxAmount
      type: object
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
    title: taxationItems
  GETCreditMemoItemTypewithSuccess:
    allOf:
    - properties:
        amount:
          description: 'The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.

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

            '
          format: double
          type: number
        appliedAmount:
          description: 'The applied amount of the credit memo item.

            '
          format: double
          type: number
        appliedToItemId:
          description: 'The unique ID of the credit memo item that the discount charge is applied to.

            '
          type: string
        comment:
          description: 'Comments about the credit 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 credit memo item.

            '
          type: string
        createdDate:
          description: 'The date and time when the credit 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
        creditFromItemId:
          description: 'The ID of the credit from item.

            '
          type: string
        creditFromItemSource:
          description: 'The type of the credit from item.

            '
          enum:
          - InvoiceItem
          - CreditMemoItem
          type: string
        creditTaxItems:
          description: "Container for the taxation items of the credit 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/GETCMTaxItemType'
          type: array
        description:
          description: 'The description of the credit 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 credit 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 credit 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. \n"
              type: string
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              type: string
            onAccountAccountingCodeType:
              description: 'The type of the accounting code that maps to an on account in your accounting system.

                '
              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. \n"
              type: string
            revenueRecognitionRuleName:
              description: 'The name of the revenue recognition rule governing the revenue schedule.

                '
              type: string
            revenueScheduleNumber:
              description: '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 credit memo item.

            '
          type: string
        invoiceScheduleId:
          description: "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
          type: string
        invoiceScheduleItemId:
          description: 'The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule" target="_blank">Billing Schedule</a> feature enabled.

            '
          type: string
        numberOfDeliveries:
          description: "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"
          type: number
        processingType:
          description: "The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. \n"
          type: string
        quantity:
          description: 'The number of units for the credit memo item.

            '
          format: double
          type: number
        refundAmount:
          description: 'The amount of the refund on the credit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: "The service end date of the credit memo item. \n"
          format: date
          type: string
        serviceStartDate:
          description: 'The service start date of the credit memo item.

            '
          format: date
          type: string
        sku:
          description: 'The SKU for the product associated with the credit 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 credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.

            '
          type: string
        soldToContactSnapshotId:
          description: 'The ID of the sold-to contact snapshot associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.

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


            - If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge.

            - If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item.

            - If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge.

            - If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item.

            '
          type: string
        sourceItemType:
          description: "The type of the source item.\n\n- If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. \n- If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.\n- If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.\n- If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.\n             \n"
          enum:
          - SubscriptionComponent
          - InvoiceDetail
          - ProductRatePlanCharge
          - OrderLineItem
          type: string
        subscriptionId:
          description: 'The ID of the subscription associated with the credit memo item.

            '
          type: string
        taxMode:
          description: 'The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.

            '
          enum:
          - TaxExclusive
          - TaxInclusive
          type: string
        taxationItems:
          description: "Container for the taxation items of the credit 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/GETCMTaxItemTypeNew'
              type: array
            nextPage:
              description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

                '
              format: URL
              type: string
          type: object
        unappliedAmount:
          description: 'The unapplied amount of the credit memo item.

            '
          format: double
          type: number
        unitOfMeasure:
          description: 'The units to measure usage.

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

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the credit 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/CreditMemoItemObjectCustomFields'
    title: items
  GETTaxationItemsOfCreditMemoItemType:
    allOf:
    - properties:
        data:
          description: 'Container for the taxation items of the credit memo item.

            '
          items:
            $ref: '#/definitions/GETCMTaxItemTypeNew'
          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
  PUTBulkCreditMemosRequestType:
    allOf:
    - properties:
        memos:
          description: 'The container for a list of credit memos. The maximum number of credit memos is 50.

            '
          items:
            $ref: '#/definitions/PUTCreditMemosWithIdType'
          maxItems: 50
          type: array
      type: object
    example:
      memos:
      - autoApplyUponPosting: false
        comment: new comment
        effectiveDate: '2017-04-17'
        excludeFromAutoApplyRules: false
        id: 402890555b797b57015b7986fc1a001f
        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: []
          unitOfMeasure: Test_UOM
        reasonCode: Correcting invoice error
  GETRefundCreditMemoType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.

            '
          type: string
        amount:
          description: 'The total amount of the refund.

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

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

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

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

            '
          format: date-time
          type: string
        creditMemoId:
          description: 'The ID of the credit memo that is refunded.

            '
          type: string
        financeInformation:
          description: 'Container for the finance information related to the refund.

            '
          properties:
            bankAccountAccountingCode:
              description: 'The accounting code that maps to a bank account in your accounting system.

                '
              type: string
            bankAccountAccountingCodeType:
              description: 'The type of the accounting code that maps to a bank account in your accounting system.

                '
              type: string
            transferredToAccounting:
              description: "Whether the refund 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
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              type: string
            unappliedPaymentAccountingCodeType:
              description: 'The type of the accounting code for the unapplied payment.

                '
              type: string
          type: object
        gatewayId:
          description: 'The ID of the gateway instance that processes the refund.

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

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

            '
          type: string
        gatewayState:
          description: 'The status of the refund in the gateway.

            '
          enum:
          - MarkedForSubmission
          - Submitted
          - Settled
          - NotSubmitted
          - FailedToSettle
          type: string
        id:
          description: 'The ID of the created refund.

            '
          type: string
        markedForSubmissionOn:
          description: 'The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        methodType:
          description: 'How an external refund was issued to a customer.

            '
          enum:
          - ACH
          - Cash
          - Check
          - CreditCard
          - PayPal
          - WireTransfer
          - DebitCard
          - CreditCardReferenceTransaction
          - BankTransfer
          - Other
          type: string
        number:
          description: 'The unique identification number of the refund.

            '
          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
        paymentId:
          description: 'The ID of the payment associated with the refund.

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

            '
          type: string
        paymentMethodSnapshotId:
          description: 'The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.

            '
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction.

            '
          type: string
        referenceId:
          description: 'The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

            '
          type: string
        refundDate:
          description: 'The date when the refund takes effect, in yyyy-mm-dd format.

            '
          format: date
          type: string
        refundTransactionTime:
          description: 'The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        secondRefundReferenceId:
          description: 'The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          type: string
        settledOn:
          description: 'The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways.

            '
          format: date-time
          type: string
        softDescriptor:
          description: 'A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

            '
          type: string
        softDescriptorPhone:
          description: 'A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.

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

            '
          enum:
          - Processed
          - Canceled
          - Error
          - Processing
          type: string
        submittedOn:
          description: 'The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        type:
          description: 'The type of the refund.

            '
          enum:
          - External
          - Electronic
          type: string
        updatedById:
          description: 'The ID of the Zuora user who last updated the refund.

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

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
  CreditMemoUnapplyDebitMemoRequestType:
    properties:
      amount:
        description: 'The credit memo amount to be unapplied from the debit memo.

          '
        format: double
        type: number
      debitMemoId:
        description: 'The unique ID of the debit memo that the credit memo is unapplied from.

          '
        type: string
      items:
        description: 'Container for items. The maximum number of items is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoUnapplyDebitMemoItemRequestType'
        type: array
    required:
    - amount
    - debitMemoId
    title: debitMemos
    type: object
  PUTCreditMemoWriteOff:
    allOf:
    - properties:
        comment:
          description: 'Comments about the debit memo.

            '
          type: string
        memoDate:
          description: 'The creation date of the debit memo and the effective date of the credit memo. Credit memos are applied to the corresponding debit memos on `memoDate`. By default, `memoDate` is set to the current date.

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

            '
          type: string
      type: object
    - $ref: '#/definitions/DebitMemoObjectCustomFieldsCMWriteOff'
    example:
      DMCustomField__c: Custom fields
      comment: Comments about the debit memo.
      memoDate: '2022-05-05'
  PutReverseCreditMemoResponseType:
    properties:
      creditMemo:
        description: 'Container for the credit memo that is automatically generated during the reversal of the invoice that is related to the credit memo. If no related invoice is reversed, the value is null.

          '
        properties:
          id:
            description: The ID of the credit memo.
            type: string
        type: object
      debitMemo:
        description: 'Container for the debit memo that is automatically generated during the credit memo reversal.

          '
        properties:
          id:
            description: The ID of the debit memo.
            type: string
        type: object
      success:
        description: 'Returns `true` if the request was processed successfully.

          '
        type: boolean
    type: object
  CreditMemoItemFromInvoiceItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the credit memo item.

            '
          format: double
          type: number
        comment:
          description: 'Comments about the credit 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 credit 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 credit memo item.

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

                '
              maxLength: 100
              minLength: 0
              type: string
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              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 credit memo item.

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

            '
          format: date
          type: string
        serviceStartDate:
          description: 'The service start date of the credit memo item.

            '
          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/CreditMemoTaxItemFromInvoiceTaxItemType'
          type: array
        taxMode:
          default: TaxExclusive
          description: 'The tax mode of the credit memo item, indicating whether the amount of the credit 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 credit memo items. The corresponding invoice item must use the same tax engine as the credit 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
      - invoiceItemId
      type: object
    - $ref: '#/definitions/CreditMemoItemObjectCustomFields'
    title: items
  PUTCreditMemoWriteOffResponseType:
    properties:
      debitMemo:
        description: 'Container for the credit memo that is automatically created.

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

              '
            type: string
        type: object
      success:
        description: 'Returns `true` if the request was processed successfully.

          '
        type: boolean
    type: object
  GETCMTaxItemType:
    allOf:
    - properties:
        appliedAmount:
          description: 'The applied amount of the taxation item.

            '
          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:
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              type: string
            onAccountAccountingCodeType:
              description: 'The type of the accounting code that maps to an on account in your accounting system.

                '
              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
        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
        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 credit memo.

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

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

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the credit 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/CreditTaxationItemObjectCustomFields'
    title: creditTaxItems
  RefundObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Refund 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 Refund object.

      '
    title: refundFieldsCustom
    type: object
  CreditMemoFromInvoiceType:
    allOf:
    - properties:
        autoApplyToInvoiceUponPosting:
          description: 'Whether the credit memo automatically applies to the invoice upon posting.

            '
          type: boolean
        autoPost:
          default: false
          description: "Whether to automatically post the credit memo after it is created. \nSetting this field to `true`, you do not need to separately call the [Post credit memo](/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo.\n"
          type: boolean
        comment:
          description: 'Comments about the credit memo.

            '
          maxLength: 255
          minLength: 0
          type: string
        effectiveDate:
          description: 'The date when the credit memo takes effect.

            '
          format: date
          type: string
        excludeFromAutoApplyRules:
          description: 'Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices.

            '
          type: boolean
        invoiceId:
          description: "The ID of the invoice that the credit 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/CreditMemoItemFromInvoiceItemType'
          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 credit memo.

            '
          type: boolean
      type: object
    - $ref: '#/definitions/CreditMemoObjectNSFields'
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
    example:
      autoApplyToInvoiceUponPosting: false
      autoPost: false
      comment: the comment
      effectiveDate: '2016-11-30'
      excludeFromAutoApplyRules: false
      items:
      - amount: 1
        comment: This is comment!
        invoiceItemId: 4028905558b483220158b48983dd0015
        quantity: 1
        serviceEndDate: '2016-11-30'
        serviceStartDate: '2016-11-01'
        skuName: SKU-30
        taxItems:
        - amount: 0.01
          jurisdiction: CALIFORNIA
          locationCode: '06'
          sourceTaxItemId: 4028905558b483220158b48983150010
          taxCode: null
          taxCodeDescription: This is tax code description!
          taxDate: '2016-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: Write-off
  UnapplyCreditMemoType:
    example:
      effectiveDate: '2017-03-02'
      invoices:
      - amount: 1
        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
        items:
        - amount: 0.9
          creditMemoItemId: 4028905f5a890526015a8d73f74b0016
          invoiceItemId: 4028905f5a87c0ff015a87d3f90c0045
        - amount: 0.1
          creditTaxItemId: 4028905f5a890526015a8d73f90c0018
          taxItemId: 4028905f5a87c0ff015a87d3f884003f
    properties:
      debitMemos:
        description: 'Container for debit memos that the credit memo is unapplied from. The maximum number of debit memos is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoUnapplyDebitMemoRequestType'
        type: array
      effectiveDate:
        description: 'The date when the credit memo is unapplied.

          '
        format: date
        type: string
      invoices:
        description: 'Container for invoices that the credit memo is unapplied from. The maximum number of invoices is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoUnapplyInvoiceRequestType'
        type: array
    type: object
  GETCreditMemoPartTypewithSuccess:
    properties:
      amount:
        description: 'The amount of the credit memo part.

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

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

          '
        format: date-time
        type: string
      debitMemoId:
        description: 'The ID of the debit memo associated with the credit memo part.

          '
        type: string
      id:
        description: 'The ID of the credit memo part.

          '
        type: string
      invoiceId:
        description: 'The ID of the invoice associated with the credit memo part.

          '
        type: string
      updatedById:
        description: 'The ID of the Zuora user who last updated the credit memo part.

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

          '
        format: date-time
        type: string
    title: parts
    type: object
  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
  GETCMTaxItemTypeNew:
    allOf:
    - properties:
        appliedAmount:
          description: 'The applied amount of the taxation item.

            '
          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:
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              type: string
            onAccountAccountingCodeType:
              description: 'The type of the accounting code that maps to an on account in your accounting system.

                '
              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
        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
        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 credit memo.

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

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

            '
          format: date
          type: string
        taxRate:
          description: 'The tax rate applied to the credit 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/CreditTaxationItemObjectCustomFields'
    title: data
  CreditMemoFromChargeType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the account associated with the credit memo.


            **Note**: When creating credit 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 customer account associated with the credit memo.


            **Note**: When creating credit 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
        autoPost:
          default: false
          description: "Whether to automatically post the credit memo after it is created. \n\nSetting this field to `true`, you do not need to separately call the [Post a credit memo](/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo.\n"
          type: boolean
        charges:
          description: 'Container for product rate plan charges. The maximum number of items is 1,000.

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

            '
          type: string
        currency:
          description: 'The code of a currency as defined in Billing Settings through the Zuora UI.


            If you do not specify a currency during credit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings.


            **Note**: This field is available only if you have the <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.

            '
          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/CreditMemoFromChargeCustomRatesType'
          maxItems: 2
          type: array
        effectiveDate:
          description: 'The date when the credit memo takes effect.

            '
          format: date
          type: string
        excludeFromAutoApplyRules:
          default: false
          description: 'Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos.

            '
          type: boolean
        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/CreditMemoObjectNSFields'
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
    example:
      accountId: 402890555a7e9791015a7f15fe44001c
      autoPost: false
      charges:
      - amount: null
        chargeId: 402890555a87d7f5015a88c613c5001e
        comment: this is comment1
        quantity: 1
        serviceEndDate: '2018-10-17'
        serviceStartDate: '2017-10-17'
      - amount: 20
        chargeId: 402890555a7d4022015a7d90906b0067
        comment: this is comment2
        serviceEndDate: '2018-10-17'
        serviceStartDate: '2017-10-17'
      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'
      excludeFromAutoApplyRules: true
      reasonCode: Correcting invoice error
    title: memos
  CreditMemoObjectNSFields:
    description: 'Container for Credit 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 credit 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
      Origin__NS:
        description: 'Origin 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
      SyncDate__NS:
        description: 'Date when the credit 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
      Transaction__NS:
        description: 'Related transaction 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
    title: creditMemoFieldsNS
    type: object
  CreditMemoApplyDebitMemoRequestType:
    properties:
      amount:
        description: 'The credit memo amount to be applied to the debit memo.

          '
        format: double
        type: number
      debitMemoId:
        description: 'The unique ID of the debit memo that the credit memo is applied to.

          '
        type: string
      items:
        description: 'Container for items. The maximum number of items is 1,000.


          If `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`.


          If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.

          '
        items:
          $ref: '#/definitions/CreditMemoApplyDebitMemoItemRequestType'
        type: array
    required:
    - amount
    - debitMemoId
    title: debitMemos
    type: object
  RefundCreditMemoItemType:
    properties:
      amount:
        description: 'The amount of the refund on the specific item.

          '
        format: double
        type: number
      creditMemoItemId:
        description: 'The ID of the credit memo item that is refunded.

          '
        type: string
      creditTaxItemId:
        description: 'The ID of the credit memo taxation item that is refunded.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  CreditMemoFromChargeDetailType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the credit 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 credit 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 later [available versions](/api-references/api/overview/#section/API-Versions/Minor-Version).

            '
          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 credit memo.

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

                '
              maxLength: 100
              minLength: 0
              type: string
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              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 credit 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 credit 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 credit memo item.

            '
          format: double
          type: number
        serviceEndDate:
          description: 'The service end date of the credit 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 credit 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/CreditMemoItemObjectCustomFields'
    title: charges
  CreditMemoApplyInvoiceRequestType:
    properties:
      amount:
        description: 'The credit memo amount to be applied to the invoice.

          '
        format: double
        type: number
      invoiceId:
        description: 'The unique ID of the invoice that the credit memo is applied to.

          '
        type: string
      items:
        description: 'Container for items. The maximum number of items is 1,000.


          If `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`.


          If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.

          '
        items:
          $ref: '#/definitions/CreditMemoApplyInvoiceItemRequestType'
        type: array
    required:
    - amount
    - invoiceId
    title: invoices
    type: object
  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
  BulkCreditMemosResponseType:
    allOf:
    - properties:
        memos:
          description: 'The container for a list of credit memos.

            '
          items:
            $ref: '#/definitions/GETCreditMemoType'
          maxItems: 50
          title: memos
          type: array
        success:
          description: 'Returns `true` if the request was processed successfully.

            '
          type: boolean
      type: object
  CreditMemoTaxItemFromInvoiceTaxItemType:
    properties:
      amount:
        description: 'The amount of the credit memo taxation item.

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

          '
        properties:
          onAccountAccountingCode:
            description: 'The accounting code that maps to an on account in your accounting system.

              '
            maxLength: 100
            minLength: 0
            type: string
          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. \n"
        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 credit memo. \n"
        type: string
      taxCodeDescription:
        description: 'The description of the tax code.

          '
        type: string
      taxDate:
        description: 'The date that the tax is applied to the credit 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 credit memo.

          '
        format: double
        type: number
      taxRateDescription:
        description: "The description of the tax rate. \n"
        type: string
      taxRateType:
        description: "The type of the tax rate applied to the credit memo. \n"
        enum:
        - Percentage
        - FlatFee
        type: string
    title: taxItems
    type: object
  POSTBulkCreditMemosRequestType:
    discriminator: sourceType
    properties:
      sourceType:
        description: "The type of the source where credit memos are created. \n\nThis enum field has the following values:\n- `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices.\n- `Standalone`: By setting this field to `Standalone`, you can create multiple credit 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 `CreditMemosFromInvoices` from the following drop-down list.\n- To view the `memos` schema if you set the `sourceType` field to `Standalone`, select `CreditMemosFromCharges` from the following drop-down list.\n"
        enum:
        - Invoice
        - Standalone
        type: string
    required:
    - sourceType
    type: object
  PutCreditMemoTaxItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the taxation item in the credit memo item.

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

            '
          properties:
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              maxLength: 100
              minLength: 0
              type: string
            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 credit 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 credit memo.

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

            '
          type: string
        taxDate:
          description: 'The date that the tax is applied to the credit 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 credit memo.

            '
          format: double
          type: number
        taxRateDescription:
          description: "The description of the tax rate. \n"
          type: string
        taxRateType:
          description: 'The type of the tax rate applied to the credit memo.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - id
      type: object
    - $ref: '#/definitions/CreditTaxationItemObjectCustomFields'
    title: taxItems
  ApplyCreditMemoType:
    example:
      effectiveDate: '2017-03-02'
      invoices:
      - amount: 1
        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
        items:
        - amount: 0.9
          creditMemoItemId: 4028905f5a890526015a8d73f74b0016
          invoiceItemId: 4028905f5a87c0ff015a87d3f90c0045
        - amount: 0.1
          creditTaxItemId: 4028905f5a890526015a8d73f90c0018
          taxItemId: 4028905f5a87c0ff015a87d3f884003f
    properties:
      debitMemos:
        description: 'Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoApplyDebitMemoRequestType'
        type: array
      effectiveDate:
        description: 'The date when the credit memo is applied.

          '
        format: date
        type: string
      invoices:
        description: 'Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.

          '
        items:
          $ref: '#/definitions/CreditMemoApplyInvoiceRequestType'
        type: array
    type: object
  POSTTaxationItemListForCMType:
    example:
      taxationItems:
      - exemptAmount: 0.0
        financeInformation:
          onAccountAccountingCode: Check
          salesTaxPayableAccountingCode: Check
        jurisdiction: CALIFORNIA
        locationCode: '06'
        memoItemId: 402890555a7e9791015a879f064d0055
        name: STATE TAX
        sourceTaxItemId: 402890555a7d4022015a7db254e200c1
        taxAmount: 0.1
        taxCode: ServiceTaxCode
        taxCodeDescription: This is tax code description!
        taxDate: '2016-09-30'
        taxRate: 0.0625
        taxRateDescription: This is tax rate description!
        taxRateType: Percentage
    properties:
      taxationItems:
        description: 'Container for taxation items.

          '
        items:
          $ref: '#/definitions/POSTTaxationItemForCMType'
        type: array
    type: object
  CreditTaxationItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Credit 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 Credit Taxation Item object.

      '
    title: creditTaxationItemFieldsCustom
    type: object
  GETCreditMemoItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax.

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

            '
          format: double
          type: number
        appliedAmount:
          description: 'The applied amount of the credit memo item.

            '
          format: double
          type: number
        appliedToItemId:
          description: 'The unique ID of the credit memo item that the discount charge is applied to.

            '
          type: string
        comment:
          description: 'Comments about the credit 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 credit memo item.

            '
          type: string
        createdDate:
          description: 'The date and time when the credit 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
        creditFromItemId:
          description: 'The ID of the credit from item.

            '
          type: string
        creditFromItemSource:
          description: 'The type of the credit from item.

            '
          enum:
          - InvoiceItem
          - CreditMemoItem
          type: string
        creditTaxItems:
          description: "Container for the taxation items of the credit 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/GETCMTaxItemType'
          type: array
        description:
          description: 'The description of the credit 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 credit 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 credit 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
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              type: string
            onAccountAccountingCodeType:
              description: 'The type of the accounting code that maps to an on account in your accounting system.

                '
              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: '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 credit memo item.

            '
          type: string
        invoiceScheduleId:
          description: "The ID of the invoice schedule associated with the credit memo item. \n\n**Note**: This field is available only if you have the <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule\" target=\"_blank\">Billing Schedule</a> feature enabled.\n"
          type: string
        invoiceScheduleItemId:
          description: 'The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item.


            **Note**: This field is available only if you have the <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule" target="_blank">Billing Schedule</a> feature enabled.

            '
          type: string
        numberOfDeliveries:
          description: "The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:\n- For the credit memo generated by a bill run, this field has a value. \n- For the credit memo generated from an invoice, this field is blank.\n\n**Note**: This field is available only if you have the Delivery Pricing feature enabled.          \n"
        organizationLabel:
          description: 'The organization that this object belongs to.


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

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

            '
          format: double
          type: number
        refundAmount:
          description: 'The amount of the refund on the credit memo item.

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

            '
          format: date
          type: string
        serviceStartDate:
          description: 'The service start date of the credit 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 credit 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 credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.

            '
          type: string
        soldToContactSnapshotId:
          description: 'The ID of the sold-to contact snapshot associated with the credit memo item.


            **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.

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


            - If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge.

            - If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item.

            - If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge.

            - If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item.

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


            - If a credit memo is not created from an invoice or a product rate plan charge or a return order line item,, the value of this field is `SubscriptionComponent`.

            - If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`.

            - If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`.

            - If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`.

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

            '
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        taxMode:
          description: 'The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax.

            '
          enum:
          - TaxExclusive
          - TaxInclusive
          type: string
        taxationItems:
          description: "Container for the taxation items of the credit 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/GETCMTaxItemTypeNew'
              type: array
            nextPage:
              description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

                '
              format: URL
              type: string
          type: object
        unappliedAmount:
          description: 'The unapplied amount of the credit memo item.

            '
          format: double
          type: number
        unitOfMeasure:
          description: 'The units to measure usage.

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

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the credit 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/CreditMemoItemObjectCustomFields'
  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
  PUTCreditMemoItemType:
    allOf:
    - properties:
        amount:
          description: 'The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax

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

            '
          type: string
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: "The flag to exclude the credit 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 credit memo item.

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

                '
              maxLength: 100
              minLength: 0
              type: string
            onAccountAccountingCode:
              description: 'The accounting code that maps to an on account in your accounting system.

                '
              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 credit memo item.

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

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

            '
          format: date
          type: string
        serviceStartDate:
          description: 'The service start date of the credit memo item.

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

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

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

            '
          type: string
      required:
      - id
      type: object
    - $ref: '#/definitions/CreditMemoItemObjectCustomFields'
    title: items
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