swagger: '2.0'
info:
  version: '2023-12-15'
  title: API Reference Accounting Codes Invoices 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: Invoices
  description: "Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts. \n\nFor more information about invoices, see <a href=\"https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/A1_Invoice_Introduction\" target=\"_blank\">Invoice</a>.\n"
paths:
  /v1/invoices/batch:
    post:
      description: 'Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers.


        To use this operation, you must have the "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default.


        ### Limitations


        This operation has the following limitations:

        * You can create a maximum of 50 invoices in one request.

        * You can create a maximum of 1,000 invoice items in one request.

        '
      summary: Create standalone invoices
      operationId: POST_StandaloneInvoices
      tags:
      - Invoices
      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
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PostBatchInvoicesType'
      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:
              invoices:
              - id: 4028818484f483d20184f5006b97003f
                invoiceNumber: INV00000001
                accountId: 4028818484f483d20184f4f7efc40001
                amount: 700.0
                amountWithoutTax: 700.0
                discount: 0.0
                invoiceDate: '2022-10-31'
                dueDate: '2022-11-30'
                autoPay: true
                comments: ''
                status: Posted
                transferredToAccounting: string
                sourceType: Subscription
                sequenceSetId: 402881e522cf4f9b0122cf5d82860003
                adjustmentAmount: 0.0
                balance: 700.0
                billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004
                createdById: 402881e522cf4f9b0122cf5d82860002
                createdDate: '2022-12-08 19:49:16'
                includesOneTime: true
                includesRecurring: true
                includesUsage: true
                lastEmailSentDate: '2022-12-08 19:51:16'
                paymentAmount: 0.0
                postedBy: 402881e522cf4f9b0122cf5d82860002
                postedDate: '2022-12-09'
                refundAmount: 0.0
                soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860005
                source: BillRun
                sourceId: BR-00000001
                targetDate: '2022-10-31'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2022-12-08 19:51:23'
                billRunId: 4028818484f483d20184f50064950035
                IntegrationId__NS: string
                IntegrationStatus__NS: string
                SyncDate__NS: string
                complexity__c: Middle
                description__c: description
                currency: USD
                success: true
              - success: false
                processId: CA037C0B8C5B0682
                reasons:
                - code: 58490020
                  message: No account is found with accountId ff8080817cda56fa017cda87aaa2071f.
                objectIndex: 1
              success: true
          schema:
            $ref: '#/definitions/PostBatchInvoiceResponse'
  /v1/invoices:
    post:
      description: 'Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.


        To use this operation, you must have the "Create Standalone Invoice" and "Modify Invoice" user permissions. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. As of Zuora Release 2022.03.R5, newly created standard Billing users have the “Create Standalone Invoice” permission enabled by default.

        '
      summary: Create a standalone invoice
      operationId: POST_StandaloneInvoice
      tags:
      - Invoices
      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
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PostInvoiceType'
      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: 4028818484f483d20184f5006b97003f
              invoiceNumber: INV00000001
              accountId: 4028818484f483d20184f4f7efc40001
              amount: 700.0
              amountWithoutTax: 700.0
              discount: 0.0
              invoiceDate: '2022-10-31'
              dueDate: '2022-11-30'
              autoPay: true
              comments: ''
              status: Posted
              transferredToAccounting: string
              sourceType: Subscription
              sequenceSetId: 402881e522cf4f9b0122cf5d82860006
              adjustmentAmount: 0.0
              balance: 700.0
              billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860007
              createdById: 402881e522cf4f9b0122cf5d82860002
              createdDate: '2022-12-08 19:49:16'
              includesOneTime: true
              includesRecurring: true
              includesUsage: true
              lastEmailSentDate: '2022-12-08 19:51:16'
              paymentAmount: 0.0
              postedBy: 402881e522cf4f9b0122cf5d82860002
              postedDate: '2022-12-09'
              refundAmount: 0.0
              soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860008
              source: BillRun
              sourceId: BR-00000001
              targetDate: '2022-10-31'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2022-12-08 19:51:23'
              billRunId: 4028818484f483d20184f50064950035
              IntegrationId__NS: string
              IntegrationStatus__NS: string
              SyncDate__NS: string
              complexity__c: Middle
              description__c: description
              currency: EUR
              success: true
          schema:
            $ref: '#/definitions/PostInvoiceResponse'
    put:
      description: "Updates multiple invoices in batches with one call. \n\n### Limitations \nThis operation has the following limitations:\n* You can update a maximum of 50 invoices by one call.\n"
      summary: Update invoices
      operationId: PUT_BatchUpdateInvoices
      tags:
      - Invoices
      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: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PutBatchInvoiceType'
      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'
  /v1/invoices/bulk-post:
    post:
      summary: Post invoices
      operationId: POST_PostInvoices
      description: 'Posts multiple invoices.


        You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices.

        '
      tags:
      - Invoices
      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
        description: ''
        required: true
        schema:
          $ref: '#/definitions/POSTInvoicesBatchPostType'
      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: ''
          schema:
            $ref: '#/definitions/InvoicesBatchPostResponseType'
          examples:
            application/json:
              success: true
              invoices:
              - id: 402890555a7e9791015a7f15fe440123
                success: true
              - id: 402890555a7e9791015a7f15fe44013a
                success: true
              - success: false
                processId: F3D4DAF98E6CE569
                reasons:
                - code: 59210020
                  message: Only invoices with Draft status can be posted.
                id: ff808081804f25b001804f2d8971079f
  /v1/invoices/{invoiceKey}:
    put:
      summary: Update an invoice
      operationId: PUT_UpdateInvoice
      description: "Updates a specific invoice. \n"
      tags:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

          '
      - name: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PutInvoiceType'
      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: ''
          schema:
            $ref: '#/definitions/PutInvoiceResponseType'
          examples:
            application/json:
              id: 40288ae9600808280160081dc9c13f15
              number: INV00000090
              accountId: 40288ae9600808280160081db1533506
              invoiceDate: '2017-11-29'
              currency: USD
              targetDate: '2017-11-29'
              dueDate: '2017-12-18'
              postedOn: null
              postedById: null
              status: Draft
              amount: 100
              taxAmount: 0
              totalTaxExemptAmount: 0
              balance: 100
              discount: 0.0
              comment: ''
              autoPay: false
              transferredToAccounting: 'No'
              creditBalanceAdjustmentAmount: 0
              createdDate: '2017-11-29 22:10:58'
              createdById: 40288ae9600808280160081d833a311a
              updatedDate: '2017-11-30 13:47:52'
              updatedById: 40288ae9600808280160081d833a311a
              cancelledOn: null,
              cancelledById: null,
              success: true
    delete:
      summary: Delete an invoice
      operationId: DELETE_DeleteInvoice
      description: 'Deletes a specific invoice.


        Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at <a href="http://support.zuora.com/" target="_blank">Zuora Global Support</a>.

        '
      tags:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-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.

                '
          description: ''
          schema:
            $ref: '#/definitions/DeleteInvoiceResponseType'
          examples:
            application/json:
              id: 40288ae9600808280160081dc9c13f15
              jobId: 40288ae9600808280160081db1533506
              jobStatus: Completed
              success: true
    get:
      summary: Retrieve an invoice
      operationId: Get_GetInvoice
      description: 'Retrieves a specific invoice.

        '
      tags:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-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.

                '
          description: ''
          schema:
            $ref: '#/definitions/PostInvoiceResponse'
          examples:
            application/json:
              id: 4028818484f483d20184f5006b97003f
              invoiceNumber: INV00000001
              accountId: 4028818484f483d20184f4f7efc40001
              amount: 700.0
              amountWithoutTax: 700.0
              discount: 0.0
              invoiceDate: '2022-10-31'
              dueDate: '2022-11-30'
              autoPay: true
              comments: ''
              status: Posted
              transferredToAccounting: string
              sourceType: Subscription
              sequenceSetId: 402881e522cf4f9b0122cf5d82860009
              adjustmentAmount: 0.0
              balance: 700.0
              billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860010
              createdById: 402881e522cf4f9b0122cf5d82860002
              createdDate: '2022-12-08 19:49:16'
              includesOneTime: true
              includesRecurring: true
              includesUsage: true
              lastEmailSentDate: '2022-12-08 19:51:16'
              paymentAmount: 0.0
              postedBy: 402881e522cf4f9b0122cf5d82860002
              postedDate: '2022-12-09'
              refundAmount: 0.0
              soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860011
              source: BillRun
              sourceId: BR-00000001
              targetDate: '2022-10-31'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2022-12-08 19:51:23'
              billRunId: 4028818484f483d20184f50064950035
              IntegrationId__NS: string
              IntegrationStatus__NS: string
              SyncDate__NS: string
              complexity__c: Middle
              description__c: description
              currency: USD
              success: true
  /v1/invoices/{invoiceKey}/application-parts:
    get:
      summary: List all application parts of an invoice
      description: '**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Retrieves information about the payments or credit memos that are applied to a specified invoice.

        '
      operationId: GET_InvoiceApplicationParts
      tags:
      - Invoices
      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: invoiceKey
        in: path
        type: string
        required: true
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-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.

                '
          description: OK
          examples:
            application/json:
              applicationParts:
              - paymentId: null
                creditMemoId: 4028905f60a165a50160b4f632ff023d
                appliedAmount: 22
                createdDate: '2018-01-02 11:42:16'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2018-01-02 11:42:16'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              - paymentId: 4028905f60a165a50160b4f5d5cb0229
                creditMemoId: null
                appliedAmount: 11
                createdDate: '2018-01-02 11:41:38'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2018-01-02 11:41:38'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GetInvoiceApplicationPartCollectionType'
  /v1/invoices/{invoiceKey}/emails:
    post:
      summary: Email an invoice
      operationId: POST_EmailInvoice
      description: "Sends a posted invoice to the specified email addresses manually.\n### Notes\n  - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice 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  - 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 **Invoice Posted Default Email 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  - The invoices 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    * The `useEmailTemplateSetting` field is set to `false`.\n    * The email addresses are not specified in the `emailAddresses` field.\n"
      tags:
      - Invoices
      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
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PostInvoiceEmailRequestType'
      - name: invoiceKey
        in: path
        type: string
        required: true
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

          '
  /v1/invoices/{invoiceKey}/files:
    post:
      summary: Upload a file for an invoice
      operationId: POST_UploadFileForInvoice
      description: 'Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.

        To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.

        This operation has the following restrictions:

        - Only the PDF file format is supported.

        - The maximum size of the PDF file to upload is 4 MB.

        - A maximum of 50 PDF files can be uploaded for one invoice.

        '
      consumes:
      - multipart/form-data
      tags:
      - Invoices
      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: invoiceKey
        in: path
        description: 'The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.

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

          '
        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: 40289f466463d683016463ef8b7301a2
          description: ''
          schema:
            $ref: '#/definitions/POSTUploadFileResponse'
      x-code-samples:
      - lang: curl
        label: Curl
        source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf" "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files"

          '
    get:
      summary: List all files of an invoice
      operationId: GET_InvoiceFiles
      description: "Retrieves the information about all PDF files of a specified invoice. \n\nInvoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\nYou can use the [Query](/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `\"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'\"`.\nSee [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information.\n"
      tags:
      - Invoices
      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'
      - name: invoiceKey
        in: path
        description: 'The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.

          '
        required: true
        type: string
      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: ''
          schema:
            $ref: '#/definitions/GETInvoiceFilesResponse'
          examples:
            application/json:
              invoiceFiles:
              - id: 2c98901f62d7d83d0162d7facec2262f
                versionNumber: 1524041954479
                pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d
              - id: 2c98901f62d7d83d0162d7f4a9792629
                versionNumber: 1524041551946
                pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f4a95c2627
              - id: 2c98901f62d7d83d0162d7f491ea2626
                versionNumber: 1524041544112
                pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f490f22624
              success: true
  /v1/invoices/{invoiceKey}/items:
    get:
      summary: List all items of an invoice
      operationId: GET_InvoiceItems
      description: "Retrieves the information about all items of a specified invoice. \n"
      tags:
      - Invoices
      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'
      - name: invoiceKey
        in: path
        description: 'The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.

          '
        required: true
        type: string
      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: ''
          schema:
            $ref: '#/definitions/GETInvoiceItemsResponse'
          examples:
            application/json:
              invoiceItems:
              - id: 2c92c095511f5b4401512682dd017989
                subscriptionName: A-S00000004
                subscriptionId: 2c92c0f9511f56b2015126814ad532cc
                serviceStartDate: 2015-11-20
                serviceEndDate: 2015-11-30
                balance: 21.1
                chargeAmount: 21.1
                chargeDescription: ''
                chargeName: Annual Fee
                chargeDate: '2015-11-20 19:53:00'
                chargeType: Recurring
                processingType: Charge
                excludeItemBillingFromRevenueAccounting: true
                chargeId: 2c92c0f9511f56b2015126814af832d2
                description: ''
                productName: TeamCollab Enterprise
                sourceItemType: SubscriptionComponent
                quantity: 1
                taxAmount: 0
                unitOfMeasure: ''
                unitPrice: 21.1
                appliedToItemId: null
                soldToContactId: 2c92c0f9511f56b2015126814ad532cd
                soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd
                invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                numberOfDeliveries: 1
                taxationItems:
                  data:
                  - balance: 2.11
                    paymentAmount: 0
                    creditAmount: 0
                    id: 2c98901a68ff26800168ffce6eeb0ffe
                    taxAmount: 2.11
                    name: taxName
                    exemptAmount: 0
                    jurisdiction: County
                    locationCode: 000-1
                    taxCode: TAXCODE-1
                    taxCodeDescription: null
                    taxDate: 2015-11-20
                    taxRate: 0.1
                    taxRateDescription: ''
                    taxRateType: Percentage
              - id: 3e28d61d442f433797e268e2b7c11eeb
                subscriptionName: A-S00000004
                subscriptionId: c2d9a5768db440cbbf2709a55c614bed
                serviceStartDate: 2015-11-20
                serviceEndDate: 2015-11-30
                chargeAmount: -2.1
                chargeDescription: ''
                chargeName: Discount
                chargeDate: '2015-11-20 19:53:00'
                chargeType: OneTime
                processingType: Discount
                sourceItemType: SubscriptionComponent
                excludeItemBillingFromRevenueAccounting: true
                chargeId: 1b3dede652fa47db833a83be55d850a5
                description: ''
                productName: TeamCollab Enterprise
                quantity: 0
                taxAmount: 0
                unitOfMeasure: ''
                unitPrice: 10.0
                appliedToItemId: 2c92c095511f5b4401512682dd017989
                soldToContactId: 2c92c0f9511f56b2015126814ad532cd
                soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd
                invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005
                invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006
                numberOfDeliveries: 1
                taxationItems:
                  data:
                  - balance: 0.21
                    paymentAmount: 0
                    creditAmount: 0
                    id: 2c98901a68ff26800168ffce6eeb0ffe
                    taxAmount: 0.21
                    name: taxName
                    exemptAmount: 0
                    jurisdiction: County
                    locationCode: 000-1
                    taxCode: TAXCODE-1
                    taxCodeDescription: null
                    taxDate: 2015-11-20
                    taxRate: 0.1
                    taxRateDescription: ''
                    taxRateType: Percentage
              success: true
  /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items:
    get:
      summary: List all taxation items of an invoice item
      operationId: GET_TaxationItemsOfInvoiceItem
      description: "Retrieves information about the taxation items of a specific invoice item. \n"
      tags:
      - Invoices
      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'
      - name: invoiceKey
        in: path
        description: 'The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.

          '
        required: true
        type: string
      - name: itemId
        in: path
        description: 'The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.

          '
        required: true
        type: string
      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: ''
          schema:
            $ref: '#/definitions/GETInvoiceTaxationItemsResponse'
          examples:
            application/json:
              data:
              - balance: 10
                paymentAmount: 0
                creditAmount: 0
                id: 2c98901a68ff26800168ffce84e3102c
                taxAmount: 10
                name: test
                exemptAmount: 0
                jurisdiction: test
                locationCode: code - 001
                taxCode: taxcode
                taxCodeDescription: description
                taxDate: 2019-02-18
                taxRate: 2
                taxRateDescription: test
                taxRateType: FlatFee
              - balance: 10
                paymentAmount: 0
                creditAmount: 0
                id: 2c98901a68ff26800168ffce85d6102e
                taxAmount: 10
                name: test
                exemptAmount: 0
                jurisdiction: test
                locationCode: code - 001
                taxCode: taxcode
                taxCodeDescription: description
                taxDate: 2019-02-18
                taxRate: 2
                taxRateDescription: test
                taxRateType: FlatFee
              success: true
  /v1/invoices/{invoiceKey}/reverse:
    put:
      summary: Reverse an invoice
      operationId: PUT_ReverseInvoice
      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\nReverses a posted invoice. \n\n**Restrictions**\n\nYou are not allowed to reverse an invoice if any of the following restrictions is met:\n* Payments and credit memos are applied to the invoice.\n* The invoice is split.\n* The invoice is not in Posted status.\n* The total amount of the invoice is less than 0 (a negative invoice).\n* Using Tax Connector for Extension Platform to calculate taxes.\n* An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items.\n\nSee [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information.\n"
      tags:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

          '
      - name: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PutReverseInvoiceType'
      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:
              creditMemo:
                id: 402890555a40ca7f015a5b099b0e307a
              success: true
          description: ''
          schema:
            $ref: '#/definitions/PutReverseInvoiceResponseType'
  /v1/invoices/{invoiceKey}/write-off:
    put:
      summary: Write off an invoice
      operationId: PUT_WriteOffInvoice
      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\nWrites off a posted invoice. \n\nBy writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero.\n\nIf you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance.\n\n**Restrictions**: You cannot write off an invoice if any of the following restrictions is met:\n* The balance of an invoice has been changed before Invoice Settlement is enabled.\n  For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice.\n* An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items.\nSee [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information.        \n"
      tags:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

          '
      - name: Request
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/PUTWriteOffInvoiceRequest'
      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:
              creditMemo:
                id: 402890555a40ca7f015a5b099b0e307a
              success: true
          description: ''
          schema:
            $ref: '#/definitions/PUTWriteOffInvoiceResponse'
  /v1/invoices/{invoiceKey}/taxationitems:
    post:
      description: 'Creates taxation items for an invoice.

        '
      summary: Create taxation items for an invoice
      operationId: POST_INV_TaxationItems
      tags:
      - Invoices
      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
                invoiceItemId: 402890555a7e9791015a879f064d0055
                jurisdiction: CALIFORNIA
                locationCode: '06'
                name: STATE TAX
                taxAmount: 0.1
                taxCode: ServiceTaxCode
                taxMode: TaxExclusive
                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:
                  accountsReceivableAccountingCode: Check
                  accountsReceivableAccountingCodeType: 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: invoiceKey
        required: true
        description: 'The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.

          '
      - name: body
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/POSTTaxationItemList'
  /v1/invoices/{invoiceKey}/einvoice/generate:
    put:
      summary: Generate an e-invoice file for an invoice
      operationId: PUT_GenerationEInvoiceGenerationForInvoices
      description: 'Generates an e-invoice file for an invoice.


        **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:
      - Invoices
      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: invoiceKey
        in: path
        required: true
        type: string
        description: 'The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-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:
  PutInvoiceResponseType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the invoice.

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

            '
          format: BigDecimal
          type: number
        autoPay:
          description: "Whether invoices are automatically picked up for processing in the corresponding payment run. \n"
          type: boolean
        balance:
          description: 'The balance of the invoice.

            '
          format: BigDecimal
          type: number
        cancelledById:
          description: 'The ID of the Zuora user who cancelled the invoice.

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

            '
          format: date-time
          type: string
        comment:
          description: "Comments about the invoice. \n"
          type: string
        createdById:
          description: 'The ID of the Zuora user who created the invoice.

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

            '
          format: date-time
          type: string
        creditBalanceAdjustmentAmount:
          description: '**Note:** This filed is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.

            The currency amount of the adjustment applied to the customer''s credit balance.

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

            '
          type: string
        discount:
          description: 'The discount of the invoice.

            '
          format: BigDecimal
          type: number
        dueDate:
          description: "The date by which the payment for this invoice is due. \n"
          format: date
          type: string
        id:
          description: 'The unique ID of the invoice.

            '
          type: string
        invoiceDate:
          description: 'The date on which to generate the invoice.

            '
          format: date
          type: string
        number:
          description: 'The unique identification number of the invoice.

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

            '
          type: string
        postedOn:
          description: "The date and time when the invoice was posted, in `yyyy-mm-dd hh:mm:ss` format. \n"
          format: date-time
          type: string
        status:
          description: 'The status of the invoice.

            '
          enum:
          - Draft
          - Posted
          - Canceled
          - Error
          type: string
        success:
          description: 'Returns `true` if the request was processed successfully.

            '
          type: boolean
        targetDate:
          description: "The target date for the invoice, in `yyyy-mm-dd` format. For example, 2017-07-20. \n"
          format: date
          type: string
        taxAmount:
          description: 'The amount of taxation.

            '
          format: BigDecimal
          type: number
        totalTaxExemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: BigDecimal
          type: number
        transferredToAccounting:
          description: 'Whether the invoice was transferred to an external accounting system.

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the invoice 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/InvoiceObjectNSFields'
    - $ref: '#/definitions/InvoiceObjectCustomFields'
  ContactCustomFields:
    additionalProperties:
      description: "Custom fields of the Contact 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.\n\n  \n  \n"
    type: object
  PutReverseInvoiceResponseType:
    properties:
      creditMemo:
        description: 'Container for the credit memo that is automatically generated when during the invoice reversal.

          '
        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 reversal of the credit memo related to this invoice. If no related credit memo is reversed, this field is not retruned in the response body.

          '
        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
  InvoiceItem:
    allOf:
    - properties:
        accountingCode:
          description: The accounting code associated with the invoice item.
          type: string
        adjustmentLiabilityAccountingCode:
          description: "The accounting code for adjustment liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        adjustmentRevenueAccountingCode:
          description: "The accounting code for adjustment revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        appliedToItemId:
          description: The unique ID of the invoice item that the discount charge is applied to.
          type: string
        availableToCreditAmount:
          description: "The amount of the invoice item that is available to credit.        \n"
          format: decimal
          type: number
        balance:
          description: "The balance of the invoice item.\n\n**Note**: This field is only available if you have the Invoice Settlement feature enabled. \n"
          format: decimal
          type: string
        bookingReference:
          description: 'The booking reference of the invoice item.

            '
          type: string
        chargeAmount:
          description: "The amount of the charge. \n\nThis amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive.\n"
          format: decimal
          type: string
        chargeDate:
          description: 'The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        chargeDescription:
          description: The description of the charge.
          type: string
        chargeId:
          description: The unique ID of the charge.
          type: string
        chargeName:
          description: The name of the charge.
          type: string
        chargeType:
          description: "The type of the charge. \n"
          enum:
          - OneTime
          - Recurring
          - Usage
          type: string
        contractAssetAccountingCode:
          description: "The accounting code for contract asset. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractLiabilityAccountingCode:
          description: "The accounting code for contract liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractRecognizedRevenueAccountingCode:
          description: "The accounting code for contract recognized revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        deferredRevenueAccountingCode:
          description: 'The deferred revenue accounting code associated with the invoice item.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        description:
          description: The description of the invoice item.
          type: string
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the invoice 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: Item ID.
          type: string
        invoiceScheduleId:
          description: 'The ID of the invoice schedule item by which Invoice Schedule Item the invoice item is generated by when the Invoice Schedule Item is executed.


            **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 in the **Early Adopter** phase enabled.

            '
          type: string
        invoiceScheduleItemId:
          description: 'The ID of the invoice schedule item associated with the invoice 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 in the **Early Adopter** phase enabled.

            '
          type: string
        itemType:
          description: 'The type of the invoice item.

            '
          type: string
        numberOfDeliveries:
          description: 'The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows:


            **Note**: This field is available only if you have the Delivery Pricing feature enabled.

            '
        processingType:
          description: "The kind of the charge for the invoice item. \n"
          enum:
          - Charge
          - Discount
          - Prepayment
          - Tax
          - Rounding
          type: string
        productName:
          description: Name of the product associated with this item.
          type: string
        productRatePlanChargeId:
          description: 'The ID of the product rate plan charge that the invoice item is created from.

            '
          type: string
        purchaseOrderNumber:
          description: 'The purchase order number associated with the invoice item.

            '
          type: string
        quantity:
          description: The quantity of this item, in the configured unit of measure for the charge.
          format: decimal
          type: string
        recognizedRevenueAccountingCode:
          description: 'The recognized revenue accounting code associated with the invoice item.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        revRecCode:
          description: 'The revenue recognition code.

            '
          type: string
        revRecTriggerCondition:
          description: 'The date when revenue recognition is triggered.

            '
          enum:
          - ContractEffectiveDate
          - ServiceActivationDate
          - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: 'The tevenue recognition rule of the invoice item.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        serviceEndDate:
          description: The end date of the service period for this item, i.e., the last day of the service period, as _yyyy-mm-dd_.
          format: date
          type: string
        serviceStartDate:
          description: The start date of the service period for this item, as _yyyy-mm-dd_. For a one-time fee item, the date of the charge.
          format: date
          type: string
        sku:
          description: 'The SKU of the invoice item.

            '
          type: string
        soldToContactId:
          description: 'The ID of the sold-to contact associated with the invoice 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 invoice item.


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

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

            '
          enum:
          - SubscriptionComponent
          - Rounding
          - ProductRatePlanCharge
          - None
          - OrderLineItem
          type: string
        subscriptionId:
          description: The ID of the subscription for this item.
          type: string
        subscriptionName:
          description: The name of the subscription for this item.
          type: string
        success:
          description: Returns `true` if the request was processed successfully.
          type: boolean
        taxAmount:
          description: Tax applied to the charge.
          format: decimal
          type: string
        taxCode:
          description: 'The tax code of the invoice item.

            **Note** Only when taxation feature is enabled, this field can be presented.

            '
          type: string
        taxMode:
          description: 'The tax mode of the invoice item.

            **Note** Only when taxation feature is enabled, this field can be presented.

            '
          type: string
        taxationItems:
          description: "Container for the taxation items of the invoice item. \n"
          properties:
            data:
              description: 'List of taxation items.

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

                '
              format: URL
              type: string
          type: object
        unbilledReceivablesAccountingCode:
          description: "The accounting code for unbilled receivables. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        unitOfMeasure:
          description: Unit used to measure consumption.
          type: string
        unitPrice:
          description: The per-unit price of the invoice item.
          format: double
          type: number
      type: object
    - $ref: '#/definitions/InvoiceItemObjectNSFields'
    - $ref: '#/definitions/InvoiceItemObjectCustomFields'
    title: invoiceItems
  InvoicePostType:
    allOf:
    - properties:
        id:
          description: 'The ID of the invoice to be posted.

            '
          type: string
        invoiceDate:
          description: 'The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period.

            '
          format: date
          type: string
      type: object
    - $ref: '#/definitions/InvoiceObjectCustomFields'
  PutInvoiceItemType:
    allOf:
    - properties:
        accountingCode:
          description: 'The accounting code associated with the invoice item.

            '
          type: string
        adjustmentLiabilityAccountingCode:
          description: "The accounting code for adjustment liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        adjustmentRevenueAccountingCode:
          description: "The accounting code for adjustment revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        amount:
          description: "The amount of the invoice item. \n\n- For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. \n- For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.\n"
          format: number
          type: string
        chargeDate:
          description: 'The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        chargeName:
          description: "The name of the charge associated with the invoice item. \n\nThis field is required if the `productRatePlanChargeId` field is not specified in the request.\n"
          type: string
        contractAssetAccountingCode:
          description: "The accounting code for contract asset. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractLiabilityAccountingCode:
          description: "The accounting code for contract liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractRecognizedRevenueAccountingCode:
          description: "The accounting code for contract recognized revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        deferredRevenueAccountingCode:
          description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        description:
          description: 'The description of the invoice item.

            '
          type: string
        discountItems:
          description: 'Container for discount items. The maximum number of discount items is 10.

            '
          items:
            $ref: '#/definitions/PutDiscountItemType'
          type: array
        excludeItemBillingFromRevenueAccounting:
          default: false
          description: "The flag to exclude the invoice 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 invoice item.

            '
          type: string
        itemType:
          description: 'The type of the invoice item.

            '
          type: string
        purchaseOrderNumber:
          description: 'The purchase order number associated the invoice item.

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

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


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        revRecCode:
          description: 'The revenue recognition code.

            '
          type: string
        revRecTriggerCondition:
          description: 'The date when revenue recognition is triggered.

            '
          enum:
          - ContractEffectiveDate
          - ServiceActivationDate
          - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: 'The name of the revenue recognition rule governing the revenue schedule.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        serviceEndDate:
          description: 'The service end date of the invoice item.

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

            '
          format: date
          type: string
        sku:
          description: 'The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.

            '
          type: string
        taxCode:
          description: "The tax code identifies which tax rules and tax rates to apply to the invoice item.\n\n**Note:** \n- This field is only available if you have Taxation enabled.\n- If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed.\n"
          type: string
        taxMode:
          description: "The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.\n\n**Note:** \n- This field is only available if you have Taxation enabled.\n- If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed.\n"
          enum:
          - TaxInclusive
          - TaxExclusive
          type: string
        unbilledReceivablesAccountingCode:
          description: "The accounting code for unbilled receivables. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        unitPrice:
          description: 'The per-unit price of the invoice item.

            '
          format: number
          type: string
        uom:
          description: 'The unit of measure.

            '
          type: string
      type: object
    - $ref: '#/definitions/InvoiceItemObjectNSFields'
    - $ref: '#/definitions/InvoiceItemObjectCustomFields'
  PUTWriteOffInvoiceRequest:
    allOf:
    - properties:
        comment:
          description: 'Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.

            '
          maxLength: 255
          minLength: 0
          type: string
        items:
          description: "Container for items. This field is optional. \n**Note:** If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice.\n"
          items:
            $ref: '#/definitions/CreditMemoItemFromWriteOffInvoice'
          type: array
        memoDate:
          description: 'The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date.


            The default value is the date when you write off the invoice.

            '
          format: date
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code `Write-off`.

            '
          type: string
      type: object
    - $ref: '#/definitions/CreditMemoObjectCustomFields'
    - $ref: '#/definitions/CreditMemoObjectNSFields'
    example:
      memoDate: '2019-01-02'
    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
  InvoiceObjectNSFields:
    description: 'Container for Invoice 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 invoice''s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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

          '
        maxLength: 255
        type: string
    title: invoiceFieldsNS
    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
  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
  GETInvoiceFilesResponse:
    properties:
      invoiceFiles:
        description: 'Container for invoice PDF files.

          '
        items:
          $ref: '#/definitions/InvoiceFile'
        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
  PutInvoiceType:
    allOf:
    - properties:
        autoPay:
          description: 'Whether invoices are automatically picked up for processing in the corresponding payment run.

            By default, invoices are automatically picked up for processing in the corresponding payment run.

            '
          type: boolean
        comments:
          description: 'Additional information related to the invoice that a Zuora user added to the invoice.

            '
          maxLength: 255
          type: string
        dueDate:
          description: 'The date by which the payment for this invoice is due.

            '
          format: date
          type: string
        invoiceDate:
          description: 'The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period.

            You can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs.

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

            '
          items:
            $ref: '#/definitions/PutInvoiceItemType'
          type: array
        transferredToAccounting:
          description: 'Whether the invoice was transferred to an external accounting system.

            '
          enum:
          - Processing
          - 'Yes'
          - Error
          - Ignore
          type: string
      type: object
    - $ref: '#/definitions/InvoiceObjectNSFields'
    - $ref: '#/definitions/InvoiceObjectCustomFields'
    example:
      accountId: 2c9890207863df710178642433c407a5
      autoPay: false
      comments: comments
      id: 2c9890207863df710178642433c307ab
      invoiceDate: '2017-02-20'
      invoiceItems:
      - amount: 300
        bookingReference: bookingReference
        chargeDate: '2020-02-01 11:00:00'
        chargeName: charge with tax amount 9
        description: description
        discountItems:
        - amount: -10
          bookingReference: discountBookingReference
          chargeDate: '2020-02-01 11:00:00'
          chargeName: discount
          description: description
          id: 2c9890207863df710178642433c3033b
          sku: SKU-0002
          unitPrice: -5.0
        id: 2c9890207863df710178642433c306ba
        quantity: 2
        serviceEndDate: '2020-02-10'
        serviceStartDate: '2020-02-01'
      transferredToAccounting: 'Yes'
  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
  PostBatchInvoiceItemResponse:
    allOf:
    - properties:
        success:
          description: 'Indicates whether the invoice is created successfully.

            '
          type: boolean
      type: object
    - $ref: '#/definitions/PostInvoiceResponse'
  DiscountItemObjectNSFields:
    description: 'Container for discount Item 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 invoice item''s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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

          '
        maxLength: 255
        type: string
    title: discountItemFieldsNS
    type: object
  PostDiscountItemType:
    allOf:
    - properties:
        accountingCode:
          description: 'The accounting code associated with the discount item.

            '
          type: string
        accountsReceivableAccountingCode:
          description: 'The accounting code for accounts receivable.

            '
          type: string
        adjustmentLiabilityAccountingCode:
          description: 'The accounting code for adjustment liability.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        adjustmentRevenueAccountingCode:
          description: 'The accounting code for adjustment revenue.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        amount:
          description: 'The amount of the discount item.

            - Should be a negative number. For example, `-10`.

            - Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).

            - For tax-exclusive discount items, this amount indicates the discount item amount excluding tax.

            - For tax-inclusive discount items, this amount indicates the discount item amount including tax.

            '
          format: number
          type: string
        bookingReference:
          description: 'The booking reference of the discount item.

            '
          type: string
        chargeDate:
          description: 'The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        chargeName:
          description: 'The name of the charge associated with the discount item.

            This field is required if the `productRatePlanChargeId` field is not specified in the request body.

            '
          type: string
        contractAssetAccountingCode:
          description: 'The accounting code for contract asset.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        contractLiabilityAccountingCode:
          description: 'The accounting code for contract liability.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        contractRecognizedRevenueAccountingCode:
          description: 'The accounting code for contract recognized revenue.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

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

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        description:
          description: 'The description of the discount item.

            '
          type: string
        itemType:
          description: 'The type of the discount item.

            '
          type: string
        productRatePlanChargeId:
          description: 'The ID of the product rate plan charge that the discount item is created from.


            If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:

            - `chargeName`

            - `sku`


            If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that [uses discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body:

            - `accountingCode`

            - `deferredRevenueAccountingCode`

            - `recognizedRevenueAccountingCode`


            If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT [use discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body:

            - `accountingCode`

            - `deferredRevenueAccountingCode`

            - `recognizedRevenueAccountingCode`

            '
          type: string
        purchaseOrderNumber:
          description: 'The purchase order number associated with the discount item.

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

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        revRecCode:
          description: 'The revenue recognition code.

            '
          type: string
        revRecTriggerCondition:
          description: 'The date when revenue recognition is triggered.

            '
          enum:
          - ContractEffectiveDate
          - ServiceActivationDate
          - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: 'The name of the revenue recognition rule governing the revenue schedule.

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        sku:
          description: 'The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.

            '
          type: string
        taxItems:
          description: 'Container for taxation items. The maximum number of taxation items is 5.


            **Note**: This field is only available only if you have Taxation enabled.

            '
          items:
            $ref: '#/definitions/PostTaxationItemType'
          type: array
        unbilledReceivablesAccountingCode:
          description: 'The accounting code for unbilled receivables.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

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

            If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF.

            '
          format: number
          type: string
      required:
      - amount
      title: invoiceItems
      type: object
    - $ref: '#/definitions/DiscountItemObjectNSFields'
    - $ref: '#/definitions/DiscountItemObjectCustomFields'
  InvoicePostResponseType:
    allOf:
    - properties:
        id:
          description: 'The ID of the invoice that was posted.

            '
          type: string
        success:
          description: 'Returns `true` if the invoice was posted successfully.

            '
          type: boolean
      type: object
  PostInvoiceType:
    allOf:
    - properties:
        accountId:
          description: "The ID of the account associated with the invoice. \n\nYou must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.\n"
          type: string
        accountNumber:
          description: 'The Number of the account associated with the invoice.

            You must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account.

            '
          type: string
        autoPay:
          default: false
          description: 'Whether invoices are automatically picked up for processing in the corresponding payment run.

            '
          type: boolean
        billToContact:
          $ref: '#/definitions/PostCreateInvoiceContactType'
        billToContactId:
          description: 'The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the `billToContact` field.


            **Note**: If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

            '
          type: string
        comments:
          description: 'Comments about the invoice.

            '
          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 standalone invoice 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).\n      \n**Note**: The API custom rate feature is permission controlled.\n"
          items:
            $ref: '#/definitions/InvoiceWithCustomRatesType'
          maxItems: 2
          type: array
        dueDate:
          description: 'The date by which the payment for this invoice is due, in `yyyy-mm-dd` format.

            '
          format: date
          type: string
        invoiceDate:
          description: 'The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period.

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

            '
          items:
            $ref: '#/definitions/PostInvoiceItemType'
          type: array
        invoiceNumber:
          description: "A customized invoice number with the following format requirements:\n- Max length: 32 characters\n- Acceptable characters: a-z,A-Z,0-9,-,_,\n\nPurely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use `202310000300`, `2003`, `INV202310000300`, or `2023-09-100009785` as invoice numbers.\n\nThe value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out [things to note and troubleshooting steps](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Unified_Invoicing/Import_external_invoices_as_standalone_invoices?#Customizing_invoice_number). \n"
          type: string
        paymentTerm:
          description: 'The ID or name of the payment term associated with the invoice. For example, `Net 30`. The payment term determines the due dates of invoices.


            **Note**: If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

            '
          type: string
        sequenceSet:
          description: 'The ID or name of the sequence set associated with the invoice.


            **Note**: If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

            '
          type: string
        soldToContact:
          $ref: '#/definitions/PostCreateInvoiceContactType'
        soldToContactId:
          description: 'The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the `soldToContact` field.


            **Note**: If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

            '
          type: string
        soldToSameAsBillTo:
          default: false
          description: "Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the `soldToContact` and `soldToContactId` fields.\n\nThe created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body:\n\n- This field is set to `true`. \n- A bill-to contact or bill-to contact ID is specified.\n- Neither sold-to contact nor sold-to contact ID is specified.\n\n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
          type: boolean
        status:
          default: Draft
          description: 'The status of invoice. By default, the invoice status is Draft.


            When creating an invoice, if you set this field to `Posted`, the invoice is created and posted directly.

            '
          enum:
          - Draft
          - Posted
          type: string
        templateId:
          description: 'The ID of the invoice template associated with the invoice.


            **Note**: If you have the <a href="https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes" target="_blank">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.

            '
          type: string
        transferredToAccounting:
          enum:
          - Processing
          - Error
          - Ignore
          - 'Yes'
          - 'No'
          type: string
      required:
      - invoiceDate
      title: invoices
      type: object
    - $ref: '#/definitions/InvoiceObjectNSFields'
    - $ref: '#/definitions/InvoiceObjectCustomFields'
    example:
      accountId: 2c9890207863df710178642433c407a5
      autoPay: false
      comments: comments
      currency: EUR
      customRates:
      - currency: CAD
        customFxRate: 2.22
        rateDate: '2022-10-21'
      - currency: EUR
        customFxRate: 2.22
        rateDate: '2022-10-21'
      invoiceDate: '2020-02-01'
      invoiceItems:
      - amount: 300
        bookingReference: bookingReference
        chargeDate: '2020-02-01 11:00:00'
        chargeName: charge with tax amount 9
        description: description
        discountItems:
        - amount: -10
          bookingReference: discountBookingReference
          chargeDate: '2020-02-01 11:00:00'
          chargeName: discount
          description: description
          sku: SKU-0002
          taxItems:
          - exemptAmount: 0
            jurisdiction: jurisdiction
            locationCode: locationCode
            name: country tax
            taxAmount: -1
            taxCode: country tax code
            taxCodeDescription: country tax code, tax rate 10%
            taxDate: '2021-02-08'
            taxMode: TaxExclusive
            taxRate: 0.1
            taxRateDescription: country tax
            taxRateType: Percentage
        excludeItemBillingFromRevenueAccounting: true
        quantity: 2
        serviceEndDate: '2020-02-10'
        serviceStartDate: '2020-02-01'
        taxItems:
        - exemptAmount: 0
          jurisdiction: juristiction
          locationCode: locationCode
          name: country tax
          taxAmount: 9
          taxCode: tax code
          taxCodeDescription: tax code description
          taxDate: '2020-02-01'
          taxMode: TaxExclusive
          taxRate: 0.03
          taxRateDescription: tax rate description
          taxRateType: Percentage
      invoiceNumber: 6LU5F8NW00001
  DiscountItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Discount 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 an Discount Item object.

      '
    title: discountItemFieldsCustom
    type: object
  GETInvoiceTaxationItemsResponse:
    properties:
      data:
        description: 'Container for the taxation items of the invoice item.

          '
        items:
          $ref: '#/definitions/GETInvoiceTaxItemType'
        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
  InvoicesBatchPostResponseType:
    allOf:
    - properties:
        invoices:
          description: 'The container for a list of posted invoices.

            '
          items:
            $ref: '#/definitions/InvoicePostResponseType'
          title: invoices
          type: array
        success:
          description: 'Returns `true` if the request has one of invoices was posted successfully.

            '
          type: boolean
      type: object
  PostInvoiceResponse:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account associated with the invoice.

            '
          type: string
        adjustmentAmount:
          description: 'The amount of the invoice adjustments associated with the invoice.

            '
          format: number
          type: string
        amount:
          description: 'The total amount of the invoice.

            '
          format: number
          type: string
        amountWithoutTax:
          description: 'The invoice amount excluding tax.

            '
          format: number
          type: string
        autoPay:
          description: 'Whether invoices are automatically picked up for processing in the corresponding payment run.

            '
          type: boolean
        balance:
          description: 'The remaining balance of the invoice after all payments, adjustments, and refunds are applied.

            '
          format: number
          type: string
        billRunId:
          description: 'The id of bill run if the invoice is generated by a bill run.

            '
          type: string
        billToContactId:
          description: 'The ID of the bill-to contact associated with the invoice.

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

            '
          type: string
        comments:
          description: 'Comments about the invoice.

            '
          type: string
        createdById:
          description: 'The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run.

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

            '
          format: date-time
          type: string
        creditBalanceAdjustmentAmount:
          description: "The currency amount of the adjustment applied to the customer's credit balance.\n\n **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled.\n"
          format: number
          type: string
        creditMemoAmount:
          description: 'The currency amount of all credit memos applied to this invoice.


            **Note:** This field 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.

            '
          format: number
          type: string
        currency:
          description: 'The currency of the invoice.


            **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
        discount:
          description: 'the invoice discount amount.

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

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

            '
          type: string
        einvoiceErrorMessage:
          description: 'The error message when status is "Failed". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor.

            '
          type: string
        einvoiceFileId:
          description: 'The ID of the e-invoice file.

            '
          type: string
        einvoiceStatus:
          description: 'It could be Processing, Success, Failed. If it’s Failed, it will have an error code and message. If it’s Success, both error code and message are empty, and eInvoiceFileId stores the file id of e-invoice.

            '
          enum:
          - Processing
          - Success
          - Failed
          type: string
        id:
          description: 'The unique ID of the invoice.

            '
          type: string
        includesOneTime:
          description: 'Specifies whether the invoice includes one-time charges.

            '
          type: boolean
        includesRecurring:
          description: 'Specifies whether the invoice includes recurring charges.

            '
          type: boolean
        includesUsage:
          description: 'Specifies whether the invoice includes usage charges.

            '
          type: boolean
        invoiceDate:
          description: 'The date that appears on the invoice being created.

            '
          format: date
          type: string
        invoiceNumber:
          description: 'The unique identification number of the invoice.

            '
          type: string
        lastEmailSentDate:
          description: 'The date when the invoice was last emailed.

            '
          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
        paymentAmount:
          description: 'The amount of payments applied to the invoice.

            '
          format: number
          type: string
        paymentTerm:
          description: 'The name of payment term associated with the invoice.

            '
          type: string
        postedBy:
          description: 'The user ID of the person who moved the invoice to Posted status.

            '
          type: string
        postedDate:
          description: 'The date when the invoice was posted.

            '
          format: date
          type: string
        refundAmount:
          description: 'Specifies the amount of a refund that was applied against an earlier payment on the invoice.

            '
          format: number
          type: string
        sequenceSetId:
          description: 'The ID of the sequence set associated with the invoice.

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

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

            '
          type: string
        source:
          description: 'The source of the invoice.

            '
          enum:
          - BillRun
          - API
          - ApiSubscribe
          - ApiAmend
          type: string
        sourceId:
          description: 'The ID of the invoice source.

            If an invoice 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 invoice source.

            '
          enum:
          - Subscription
          - Standalone
          - Order
          - Consolidation
          type: string
        status:
          description: 'The status of the invoice.

            '
          enum:
          - Draft
          - Posted
          type: string
        targetDate:
          description: 'This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run.

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

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

            '
          format: number
          type: string
        taxMessage:
          description: 'The message that the tax engine return if it calculates the taxes of this invoice fails.

            '
          type: string
        taxStatus:
          description: 'The status that the tax engine return after it calculates the taxes of this invoice.

            '
          enum:
          - Complete
          - Error
          - UnknownError
          - DuplicateDoc
          - InvalidRequest
          - InvalidResponse
          - TaxEngineError
          - ConcurrentModify
          - InternalServerError
          - TaxCodeTemplateError
          type: string
        templateId:
          description: "The ID of the invoice template.\n\n- If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature enabled, the value of this field depends on the configuration of the invoice template. \n  - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription.\n  - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account.\n- If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`.\n"
          type: string
        transferredToAccounting:
          description: 'Whether the invoice was transferred to an external accounting system.

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

            '
          type: string
        updatedDate:
          description: 'The date when the invoice was last updated.

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/InvoiceObjectNSFields'
    - $ref: '#/definitions/InvoiceObjectCustomFields'
  PutBatchInvoiceType:
    example:
      invoices:
      - autoPay: false
        dueDate: '2017-12-16'
        id: 2c93808457d787030157e031d86c4c57
        transferredToAccounting: 'Yes'
      - autoPay: false
        dueDate: '2017-12-27'
        id: 2c92c8955bd63cc1015bd7c151af02ab
        transferredToAccounting: 'Yes'
      - id: 2c92c8955bd63cc1015bd7c151af02dc
        invoiceDate: '2017-11-27'
    properties:
      invoices:
        description: 'Container for invoice update details.

          '
        items:
          $ref: '#/definitions/BatchInvoiceType'
        type: array
    type: object
  PutDiscountItemType:
    allOf:
    - properties:
        accountingCode:
          description: 'The accounting code associated with the discount item.

            '
          type: string
        adjustmentLiabilityAccountingCode:
          description: 'The accounting code for adjustment liability.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        adjustmentRevenueAccountingCode:
          description: 'The accounting code for adjustment revenue.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        amount:
          description: 'The amount of the discount item.

            - Should be a negative number. For example, `-10`.

            - Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model).

            - For tax-exclusive discount items, this amount indicates the discount item amount excluding tax.

            - For tax-inclusive discount items, this amount indicates the discount item amount including tax.

            '
          format: number
          type: string
        bookingReference:
          description: 'The booking reference of the discount item.

            '
          type: string
        chargeDate:
          description: 'The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        chargeName:
          description: 'The name of the charge associated with the discount item.

            This field is required if the `productRatePlanChargeId` field is not specified in the request.

            '
          type: string
        contractAssetAccountingCode:
          description: 'The accounting code for contract asset.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        contractLiabilityAccountingCode:
          description: 'The accounting code for contract liability.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

            '
          type: string
        contractRecognizedRevenueAccountingCode:
          description: 'The accounting code for contract recognized revenue.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

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

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        description:
          description: 'The description of the discount item.

            '
          type: string
        id:
          description: 'The unique ID of the discount item.

            '
          type: string
        itemType:
          description: 'The type of the discount item.

            '
          type: string
        purchaseOrderNumber:
          description: 'The purchase order number associated with the discount item.

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

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        revRecCode:
          description: 'The revenue recognition code.

            '
          type: string
        revRecTriggerCondition:
          description: 'The date when revenue recognition is triggered.

            '
          enum:
          - ContractEffectiveDate
          - ServiceActivationDate
          - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: 'The name of the revenue recognition rule governing the revenue schedule.

            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        sku:
          description: 'The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product.

            '
          type: string
        unbilledReceivablesAccountingCode:
          description: 'The accounting code for unbilled receivables.

            **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled.

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

            If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF.

            '
          format: number
          type: string
      required:
      - amount
      title: invoiceItems
      type: object
    - $ref: '#/definitions/DiscountItemObjectNSFields'
    - $ref: '#/definitions/DiscountItemObjectCustomFields'
  InvoiceItemObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Invoice 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 an Invoice Item object.

      '
    title: invoiceItemFieldsCustom
    type: object
  POSTTaxationItemList:
    example:
      taxationItems:
      - exemptAmount: 0.0
        financeInformation:
          accountsReceivableAccountingCode: Check
          salesTaxPayableAccountingCode: Check
        invoiceItemId: 402890555a7e9791015a879f064d0055
        jurisdiction: CALIFORNIA
        locationCode: '06'
        name: STATE TAX
        taxAmount: 0.1
        taxCode: ServiceTaxCode
        taxCodeDescription: This is tax code description!
        taxDate: '2016-09-30'
        taxMode: TaxExclusive
        taxRate: 0.0625
        taxRateDescription: This is tax rate description!
        taxRateType: Percentage
    properties:
      taxationItems:
        description: 'Container for taxation items.

          '
        items:
          $ref: '#/definitions/POSTTaxationItemTypeForInvoice'
        type: array
    type: object
  InvoiceItemObjectNSFields:
    description: 'Container for Invoice Item 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 invoice item''s synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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

          '
        maxLength: 255
        type: string
    title: invoiceItemFieldsNS
    type: object
  DeleteInvoiceResponseType:
    properties:
      id:
        description: 'The ID of the deleted invoice.

          '
        type: string
      jobId:
        description: "The ID of the job that handles the invoice deletion operation. \n\nYou can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](/api-references/api/operation/GET_OperationJob/) API operation to query job information.\n"
        type: string
      jobStatus:
        description: "The status of the invoice deletion operation. \n"
        enum:
        - Pending
        - Completed
        type: string
      reasons:
        items:
          properties:
            code:
              description: 'The error code of the response.

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

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

          '
        type: boolean
    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
  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
  PutReverseInvoiceType:
    example:
      applyEffectiveDate: '2017-02-20'
      memoDate: '2017-02-20'
    properties:
      applyEffectiveDate:
        description: 'The date when the credit memo is applied to the invoice that will be reversed, 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 invoice and create the credit memo.

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


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

          '
        format: date
        type: string
    type: object
  PUTWriteOffInvoiceResponse:
    properties:
      creditMemo:
        description: 'Container for the credit memo that is automatically generated when writing off invoices.

          '
        properties:
          id:
            description: 'The ID of the credit memo that is created when the invoice is written off.

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

          '
        type: boolean
    type: object
  InvoiceWithCustomRatesType:
    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
    title: customRates
  InvoiceFile:
    properties:
      id:
        description: 'The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID.

          '
        type: string
      pdfFileUrl:
        description: 'The REST URL for the invoice PDF file. Click the URL to open the invoice PDF file.

          '
        type: string
      versionNumber:
        description: 'The version number of the invoice PDF file.

          '
        format: int64
        type: integer
    title: invoiceFiles
    type: object
  PostInvoiceItemType:
    allOf:
    - properties:
        accountingCode:
          description: 'The accounting code associated with the invoice item.

            '
          type: string
        adjustmentLiabilityAccountingCode:
          description: "The accounting code for adjustment liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        adjustmentRevenueAccountingCode:
          description: "The accounting code for adjustment revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        amount:
          description: "The amount of the invoice item. \n\n- For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. \n- For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax.\n"
          format: number
          type: string
        bookingReference:
          description: 'The booking reference of the invoice item.

            '
          type: string
        chargeDate:
          description: 'The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        chargeName:
          description: "The name of the charge associated with the invoice item. \n\nThis field is required if the `productRatePlanChargeId` field is not specified in the request.\n"
          type: string
        contractAssetAccountingCode:
          description: "The accounting code for contract asset. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractLiabilityAccountingCode:
          description: "The accounting code for contract liability. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        contractRecognizedRevenueAccountingCode:
          description: "The accounting code for contract recognized revenue. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        deferredRevenueAccountingCode:
          description: 'The accounting code for the deferred revenue, such as Monthly Recurring Liability.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        description:
          description: 'The description of the invoice item.

            '
          type: string
        discountItems:
          description: 'Container for discount items. The maximum number of discount items is 10.

            '
          items:
            $ref: '#/definitions/PostDiscountItemType'
          type: array
        excludeItemBillingFromRevenueAccounting:
          description: "The flag to exclude the invoice item from revenue accounting.\n\n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: boolean
        itemType:
          description: 'The type of the invoice item.

            '
          type: string
        productRatePlanChargeId:
          description: "The ID of the product rate plan charge that the invoice item is created from.\n\nIf you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body:\n- `chargeName`\n- `sku`\n- `uom`\n- `taxCode`\n- `taxMode`\n- `accountingCode`\n- `deferredRevenueAccountingCode` \n- `recognizedRevenueAccountingCode`\n"
          type: string
        purchaseOrderNumber:
          description: 'The purchase order number associated with the invoice item.

            '
          type: string
        quantity:
          default: '1'
          description: 'The number of units for the invoice item.

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


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        revRecCode:
          description: 'The revenue recognition code.

            '
          type: string
        revRecTriggerCondition:
          description: 'The date when revenue recognition is triggered.

            '
          enum:
          - ContractEffectiveDate
          - ServiceActivationDate
          - CustomerAcceptanceDate
          type: string
        revenueRecognitionRuleName:
          description: 'The name of the revenue recognition rule governing the revenue schedule.


            **Note:** This field is only available if you have Zuora Finance enabled.

            '
          type: string
        serviceEndDate:
          description: 'The service end date of the invoice item.

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

            '
          format: date
          type: string
        sku:
          description: 'The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product.

            '
          type: string
        taxCode:
          description: 'The tax code identifies which tax rules and tax rates to apply to the invoice item.


            **Note**: This field is only available only if you have Taxation enabled.

            '
          type: string
        taxItems:
          description: 'Container for taxation items. The maximum number of taxation items is 5.


            **Note**: This field is only available only if you have Taxation enabled.

            '
          items:
            $ref: '#/definitions/PostTaxationItemType'
          type: array
        taxMode:
          description: 'The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax.


            **Note**: This field is only available only if you have Taxation enabled.

            '
          enum:
          - TaxInclusive
          - TaxExclusive
          type: string
        unbilledReceivablesAccountingCode:
          description: "The accounting code for unbilled receivables. \n      \n**Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. \n"
          type: string
        unitPrice:
          description: 'The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero.

            '
          format: number
          type: string
        uom:
          description: 'The unit of measure.

            '
          type: string
      required:
      - amount
      - serviceStartDate
      title: invoiceItems
      type: object
    - $ref: '#/definitions/InvoiceItemObjectNSFields'
    - $ref: '#/definitions/InvoiceItemObjectCustomFields'
  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
  GETInvoiceTaxItemType:
    allOf:
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
    - properties:
        availableToCreditAmount:
          description: 'The amount of the invoice taxation item that is available to credit.

            '
          format: decimal
          type: number
        balance:
          description: 'The balance of the taxation item.

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

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

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

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

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

            '
          type: string
        paymentAmount:
          description: "The amount of payments applied to the taxation item. \n"
          format: double
          type: number
        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 invoice.

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

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

            '
          format: date
          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.

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      title: data
      type: object
    title: data
  GetInvoiceApplicationPartCollectionType:
    properties:
      applicationParts:
        description: 'Container for application parts.

          '
        items:
          $ref: '#/definitions/GetInvoiceApplicationPartType'
        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
  PostBatchInvoiceResponse:
    properties:
      invoices:
        items:
          $ref: '#/definitions/PostBatchInvoiceItemResponse'
        type: array
      success:
        description: 'Indicates whether the call succeeded.

          '
        type: boolean
    type: object
  POSTInvoicesBatchPostType:
    allOf:
    - properties:
        invoices:
          description: 'The container for invoices to be posted. The maximum number of invoices to be posted is 50 in one request.

            '
          items:
            $ref: '#/definitions/InvoicePostType'
          title: invoices
          type: array
      type: object
    example:
      invoices:
      - complexity__c: Middle
        description__c: description
        id: 402890555a7e9791015a7f15fe440123
        invoiceDate: '2022-10-12'
      - complexity__c: Middle
        description__c: description
        id: 402890555a7e9791015a7f15fe44013a
        invoiceDate: '2022-10-12'
      - complexity__c: Middle
        description__c: description
        id: 402890555a7e9791015a7f15fe44012b
        invoiceDate: '2022-10-12'
  PostInvoiceEmailRequestType:
    example:
      emailAddresses: contact1@example.com,contact2@example.com
      includeAdditionalEmailAddresses: false
      useEmailTemplateSetting: false
    properties:
      emailAddresses:
        description: 'The valid email addresses you want to email an invoice 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: "Whether to send an invoice to the additional email addresses of the invoice account. \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
      useEmailTemplateSetting:
        default: false
        description: "Indicates whether to email an invoice based on the email template setting. \nIf you set this field to `true`, the invoice 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
  PostCreateInvoiceContactType:
    allOf:
    - properties:
        address1:
          description: 'First address line, 255 characters or less.

            '
          maxLength: 255
          type: string
        address2:
          description: 'Second address line, 255 characters or less.

            '
          type: string
        city:
          description: 'City, 40 characters or less.

            '
          maxLength: 40
          type: string
        country:
          description: 'Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided.

            '
          type: string
        county:
          description: 'County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.

            '
          maxLength: 32
          type: string
        fax:
          description: 'Fax phone number, 40 characters or less.

            '
          maxLength: 40
          type: string
        firstName:
          description: 'First name, 100 characters or less.

            '
          maxLength: 100
          type: string
        homePhone:
          description: 'Home phone number, 40 characters or less.

            '
          maxLength: 40
          type: string
        lastName:
          description: 'Last name, 100 characters or less.

            '
          maxLength: 100
          type: string
        mobilePhone:
          description: 'Mobile phone number, 40 characters or less.

            '
          maxLength: 40
          type: string
        nickname:
          description: 'Nickname for this contact

            '
          type: string
        otherPhone:
          description: 'Other phone number, 40 characters or less.

            '
          maxLength: 40
          type: string
        otherPhoneType:
          description: 'Possible values are: `Work`, `Mobile`, `Home`, `Other`.

            '
          type: string
        personalEmail:
          description: 'Personal email address, 80 characters or less.

            '
          maxLength: 80
          type: string
        state:
          description: 'State; must be a valid state or province name or 2-character abbreviation. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided.

            '
          type: string
        taxRegion:
          description: 'If using Zuora Tax, a region string as optionally defined in your tax rules. Not required.

            '
          type: string
        workEmail:
          description: 'Work email address, 80 characters or less.

            '
          maxLength: 80
          type: string
        workPhone:
          description: 'Work phone number, 40 characters or less.

            '
          maxLength: 40
          type: string
        zipCode:
          description: 'Zip code, 20 characters or less.

            '
          maxLength: 20
          type: string
      required:
      - firstName
      - lastName
      type: object
    - $ref: '#/definitions/ContactCustomFields'
    description: "Container for bill-to or sold-to contact information. A new Contact will be created under the invoice owner account.\n            \n**Note**: If you have the <a href=\"https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_customers_at_subscription_level/Flexible_Billing_Attributes\" target=\"_blank\">Flexible Billing Attributes</a> feature disabled, this field is unavailable in the request body.\n"
    title: Contact
  CreditMemoItemFromWriteOffInvoice:
    allOf:
    - properties:
        comment:
          description: 'Comments about the credit memo item.

            '
          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
        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. \n"
          format: date
          type: string
        skuName:
          description: 'The name of the charge associated with the invoice.

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

            '
          type: string
      type: object
    - $ref: '#/definitions/CreditMemoItemObjectCustomFields'
    title: items
  InvoiceObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Invoice 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 an Invoice object.

      '
    title: invoiceFieldsCustom
    type: object
  POSTTaxationItemTypeForInvoice:
    allOf:
    - properties:
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

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

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

                '
              maxLength: 100
              minLength: 0
              type: string
            salesTaxPayableAccountingCode:
              description: 'The accounting code for the sales taxes payable.

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

            '
          type: string
        taxAmount:
          description: 'The amount of the taxation item in the invoice item.

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

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

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

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

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

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

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - invoiceItemId
      - jurisdiction
      - name
      - taxAmount
      - taxDate
      - taxRate
      - taxRateType
      title: taxItems
      type: object
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
  GETInvoiceItemsResponse:
    properties:
      invoiceItems:
        description: 'Container for invoice items.

          '
        items:
          $ref: '#/definitions/InvoiceItem'
        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
  BatchInvoiceType:
    allOf:
    - properties:
        autoPay:
          description: 'Whether invoices are automatically picked up for processing in the corresponding payment run.


            By default, invoices are automatically picked up for processing in the corresponding payment run.

            '
          type: boolean
        comments:
          description: 'Additional information related to the invoice that a Zuora user added to the invoice.

            '
          maxLength: 255
          type: string
        dueDate:
          description: 'The date by which the payment for this invoice is due.

            '
          format: date
          type: string
        id:
          description: 'The ID of the invoice to be updated.

            '
          type: string
        invoiceDate:
          description: 'The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period.


            You can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs.

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

            '
          items:
            $ref: '#/definitions/PutInvoiceItemType'
          type: array
        transferredToAccounting:
          description: 'Whether the invoice was transferred to an external accounting system.

            '
          enum:
          - Processing
          - 'Yes'
          - Error
          - Ignore
          type: string
      type: object
    - $ref: '#/definitions/InvoiceObjectNSFields'
    - $ref: '#/definitions/InvoiceObjectCustomFields'
    title: invoices
  GetInvoiceApplicationPartType:
    properties:
      appliedAmount:
        description: 'The amount that is applied to the invoice.

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

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

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

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

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

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

          '
        format: date-time
        type: string
    title: applicationParts
    type: object
  PostBatchInvoicesType:
    example:
      invoices:
      - accountId: ff8080817cda56fa017cda87aaa2071e
        autoPay: false
        comments: comments
        currency: EUR
        invoiceDate: '2020-02-01'
        invoiceItems:
        - amount: 100
          bookingReference: bookingReference
          chargeDate: '2020-02-01 00:00:00'
          description: description
          discountItems:
          - amount: -10
            bookingReference: discountBookingReference
            chargeDate: '2020-02-01 11:00:00'
            chargeName: discount
            description: description
            sku: SKU-0002
            taxItems:
            - exemptAmount: 0
              jurisdiction: jurisdiction
              locationCode: locationCode
              name: country tax
              taxAmount: -1
              taxCode: country tax code
              taxCodeDescription: country tax code, tax rate 10%
              taxDate: '2021-02-08'
              taxMode: TaxExclusive
              taxRate: 0.1
              taxRateDescription: country tax
              taxRateType: Percentage
          productRatePlanChargeId: ff8080817cda56fa017cda87999d071b
          purchaseOrderNumber: PO-000303
          quantity: 1
          serviceEndDate: '2020-02-10'
          serviceStartDate: '2020-02-01'
          taxItems:
          - exemptAmount: 0
            jurisdiction: juristiction
            locationCode: locationCode
            name: country tax
            taxAmount: 10
            taxCode: tax code
            taxCodeDescription: tax code description
            taxDate: '2020-02-01'
            taxMode: TaxExclusive
            taxRate: 0.01
            taxRateDescription: tax rate description
            taxRateType: Percentage
        - amount: 100
          bookingReference: bookingReference
          chargeDate: '2020-02-01 00:00:00'
          chargeName: charge name
          description: description
          purchaseOrderNumber: PO-000303
          quantity: 1
          serviceEndDate: '2020-02-10'
          serviceStartDate: '2020-02-01'
          sku: sku-001
          uom: each
      - accountId: ff8080817cda56fa017cda87aaa2071e
        autoPay: false
        comments: comments
        currency: EUR
        invoiceDate: '2020-02-01'
        invoiceItems:
        - amount: 100
          bookingReference: bookingReference
          chargeDate: '2020-02-01 00:00:00'
          description: description
          productRatePlanChargeId: ff8080817cda56fa017cda87999d071b
          purchaseOrderNumber: PO-000303
          quantity: 1
          serviceEndDate: '2020-02-10'
          serviceStartDate: '2020-02-01'
          taxItems:
          - exemptAmount: 0
            jurisdiction: juristiction
            locationCode: locationCode
            name: country tax
            taxAmount: 10
            taxCode: tax code
            taxCodeDescription: tax code description
            taxDate: '2020-02-01'
            taxMode: TaxExclusive
            taxRate: 0.01
            taxRateDescription: tax rate description
            taxRateType: Percentage
        - amount: 100
          bookingReference: bookingReference
          chargeDate: '2020-02-01 00:00:00'
          chargeName: charge name
          description: description
          purchaseOrderNumber: PO-000303
          quantity: 1
          serviceEndDate: '2020-02-10'
          serviceStartDate: '2020-02-01'
          sku: sku-001
          uom: each
      useSingleTransaction: false
    properties:
      invoices:
        description: 'Container for standalone invoices.

          '
        items:
          $ref: '#/definitions/PostInvoiceType'
        type: array
      useSingleTransaction:
        description: 'Whether a batch request is handled with a single transaction.


          - `true` indicates that a batch request will be handled with a single transaction.

          - `false`  indicates that the standalone invoices to be created in a batch request will be handled with separated transactions.


          If the field is set to `false`, a failure in the batch request will not cause the whole request to fail, so you have to retry the whole batch request.

          '
        type: boolean
    type: object
  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
  PostTaxationItemType:
    allOf:
    - properties:
        exemptAmount:
          description: 'The calculated tax amount excluded due to the exemption.

            '
          format: number
          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 taxation.

            '
          type: string
        taxAmount:
          description: 'The amount of the taxation item in the invoice item.

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

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

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

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

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

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

            '
          enum:
          - Percentage
          - FlatFee
          type: string
      required:
      - name
      - taxAmount
      - taxCode
      - taxDate
      - taxMode
      - taxRate
      - taxRateType
      title: taxItems
      type: object
    - $ref: '#/definitions/TaxationItemObjectCustomFields'
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