swagger: '2.0'
info:
  version: '2023-12-15'
  title: API Reference Accounting Codes Payments 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: Payments
  description: 'Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds.

    For more information about payments, see <a href="https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/K_Payment_Operations" target="_blank">Payments</a>.

    '
paths:
  /v1/payments:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates a payment in the following scenarios:\n\n- A full or partial payment on an invoice or a debit memo\n- A full or partial payment on several invoices and debit memos\n- An unapplied payment in the following situations:\n  - You do not know which customer account the payment belongs to.\n  - You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to.\n  - You receive a payment from your customer that exceeds the balance on the invoice.\n  - You receive a payment from your customer before the invoice has been created.\n  - You intend to create a payment without any invoices or debit memos.\n- A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings. \n\n  The support for standalone payments is in the Early Adopter phase. To manage and access this feature through the self-service interface, see [Manage Features](https://knowledgecenter.zuora.com/Zuora_Payments/Payments_Settings/Manage_Features) in the Knowledge Center.\n\n\nIf you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account.\n\nWhen you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000.\n\nFor more information, see [Create Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments) and [Create Payments Without Specifying Customer Accounts](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments_Without_Specifying_Customer_Accounts).\n    \n"
      summary: Create a payment
      operationId: POST_CreatePayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 44.1
              unappliedAmount: 0
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: normal payment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 11:30:37'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentTypeWithPaymentOption'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/CreatePaymentType'
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all payments from all your customer accounts.\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`.\n\nExamples:\n\n- /v1/payments?status=Processed\n\n- /v1/payments?currency=USD&status=Processed\n\n- /v1/payments?status=Processed&type=External&sort=+number\n"
      summary: List payments
      operationId: GET_RetrieveAllPayments
      tags:
      - Payments
      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:
              payments:
              - id: 4028905f5a87c0ff015a87eb6b75007f
                number: P-00000001
                status: Processed
                type: External
                accountId: 4028905f5a87c0ff015a87d25ae90025
                accountNumber: A00000001
                amount: 44.1
                appliedAmount: 44.1
                unappliedAmount: 0
                refundAmount: 0
                creditBalanceAmount: 0
                currency: USD
                effectiveDate: '2017-03-01'
                comment: normal payment
                paymentGatewayNumber: PG-00000001
                paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
                paymentMethodSnapshotId: null
                authTransactionId: null
                bankIdentificationNumber: null
                gatewayId: null
                gatewayOrderId: null
                gatewayResponse: null
                gatewayResponseCode: null
                gatewayState: NotSubmitted
                markedForSubmissionOn: null
                referenceId: null
                secondPaymentReferenceId: null
                softDescriptor: null
                softDescriptorPhone: null
                submittedOn: null
                settledOn: null
                cancelledOn: null
                createdDate: '2017-03-01 11:30:37'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 11:30:37'
                updatedById: 402881e522cf4f9b0122cf5d82860002
                financeInformation:
                  bankAccountAccountingCode: null
                  bankAccountAccountingCodeType: null
                  unappliedPaymentAccountingCode: null
                  unappliedPaymentAccountingCodeType: null
                  transferredToAccounting: 'No'
                gatewayReconciliationStatus: null
                gatewayReconciliationReason: null
                payoutId: null
              success: true
          schema:
            $ref: '#/definitions/PaymentCollectionResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - name: accountId
        in: query
        type: string
        required: false
        description: 'This parameter filters the response based on the `accountId` field.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

          '
      - name: sort
        in: query
        type: string
        required: false
        description: "This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example:  *operator* *field_name*, *operator* *field_name*  \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n  - The `-` operator indicates an ascending order.\n  - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by payment number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n  - number\n  - accountId\n  - amount\n  - appliedAmount\n  - unappliedAmount\n  - refundAmount\n  - creditBalanceAmount\n  - effectiveDate\n  - createdDate\n  - createdById\n  - updatedDate\n  - updatedById\n  \nExamples:\n\n- /v1/payments?sort=+number\n\n- /v1/payments?status=Processed&sort=-number,+amount\n"
  /v1/payments/{paymentId}:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUpdates a payment.\n"
      summary: Update a payment
      operationId: PUT_UpdatePayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a88889fe500a8
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 0
              unappliedAmount: 44.1
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: new comment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:25:34'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/UpdatePaymentType'
      - type: string
        in: path
        name: paymentId
        required: true
        description: 'The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`.

          '
  /v1/payments/{paymentKey}:
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about one specific payment.\n"
      summary: Retrieve a payment
      operationId: GET_Payment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 44.1
              unappliedAmount: 0
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: normal payment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 11:30:37'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
    delete:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nDeletes a payment. Only payments with the Cancelled status can be deleted. \n\nIf you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be deleted.\n"
      summary: Delete a payment
      operationId: DELETE_Payment
      tags:
      - Payments
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

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

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

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

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

                '
          description: ''
          examples:
            application/json:
              success: true
          schema:
            $ref: '#/definitions/CommonResponseType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/transfer:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nTransfers an unapplied payment.\n\nFor more information, see [Transfer Unapplied Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Transfer_Unapplied_Payments).\n"
      summary: Transfer a payment
      operationId: PUT_TransferPayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a88889fe500a8
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 0
              unappliedAmount: 44.1
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: normal payment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:22:58'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/TransferPaymentType'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: "The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.          \n"
  /v1/payments/{paymentKey}/apply:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nApplies an unapplied payment to invoices and debit memos.\n\nWhen you apply a payment, the total number of invoice items and debit memo items that the payment will apply to must be less than or equal to 15,000.\n        \nIf the limit is hit, you can follow the instructions:\n- If you want to apply one payment to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to apply one payment to a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000.\n\nFor more information, see [Apply Unapplied Payments to Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Apply_Unapplied_Payments_to_Invoices_and_Debit_Memos).\n"
      summary: Apply a payment
      operationId: PUT_ApplyPayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 44.1
              unappliedAmount: 0
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: normal payment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 13:56:15'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/ApplyPaymentType'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/cancel:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCancels a payment. \n\nIf you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be cancelled.\n"
      summary: Cancel a payment
      operationId: PUT_CancelPayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Canceled
              type: External
              accountId: 4028905f5a87c0ff015a88889fe500a8
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 0
              unappliedAmount: 44.1
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: new comment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:26:57'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/parts:
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all parts of a payment. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a payment. Note that a fully refunded payment does not contain any payment part.\n"
      summary: List all parts of a payment
      operationId: GET_PaymentParts
      tags:
      - Payments
      responses:
        '200':
          headers:
            Content-Encoding:
              type: string
              description: "This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data.\n\nNote that only the following MIME types support gzipped responses:\n  - `application/json`\n  - `application/xml`\n  - `text/html`\n  - `text/csv`\n  - `text/plain`\n"
            RateLimit-Limit:
              type: string
              description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information.

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

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

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

                '
            Zuora-Track-Id:
              type: string
              maxLength: 64
              description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

                '
          description: ''
          examples:
            application/json:
              parts:
              - id: 4028905f5a87c0ff015a87eb6beb008d
                debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
                invoiceId: null
                amount: 4.1
                createdDate: '2017-03-01 11:30:37'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 11:30:37'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              - id: 4028905f5a87c0ff015a87eb6beb008c
                debitMemoId: null
                invoiceId: 4028905f5a87c0ff015a87d3f8f10043
                amount: 40
                createdDate: '2017-03-01 11:30:37'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 11:30:37'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETPaymentPartsCollectionType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/parts/{partid}:
    get:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about a specific payment part. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos.\n\nA fully refunded payment does not contain any payment part.\n"
      summary: Retrieve a payment part
      operationId: GET_PaymentPart
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6beb008d
              debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
              invoiceId: null
              amount: 4.1
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 11:30:37'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETPaymentPartType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: partid
        required: true
        description: 'The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).

          '
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/parts/{partid}/itemparts:
    get:
      description: "**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all items of a payment part. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items.\n"
      summary: List all payment part items
      operationId: GET_PaymentItemParts
      tags:
      - Payments
      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:
              itemParts:
              - id: 4028905f5a87c0ff015a87eb6bd8008a
                invoiceItemId: null
                debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
                taxItemId: null
                amount: 4
                createdDate: '2017-03-01 11:30:37'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 11:30:37'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              - id: 4028905f5a87c0ff015a87eb6bd8008b
                invoiceItemId: null
                debitMemoItemId: null
                taxItemId: 4028905f5a87c0ff015a87e49f5e0065
                amount: 0.1
                createdDate: '2017-03-01 11:30:37'
                createdById: 402881e522cf4f9b0122cf5d82860002
                updatedDate: '2017-03-01 11:30:37'
                updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETPaymentItemPartCollectionType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - $ref: '#/parameters/GLOBAL_REQUEST_page'
      - $ref: '#/parameters/GLOBAL_REQUEST_pageSize'
      - type: string
        in: path
        name: partid
        required: true
        description: 'The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).

          '
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/parts/{partid}/itemparts/{itempartid}:
    get:
      description: '**Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.


        Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items.

        '
      summary: Retrieve a payment part item
      operationId: GET_PaymentItemPart
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6bd8008a
              invoiceItemId: null
              debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
              taxItemId: null
              amount: 4
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 11:30:37'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              success: true
          schema:
            $ref: '#/definitions/GETPaymentItemPartType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - type: string
        in: path
        name: partid
        required: true
        description: 'The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](/api-references/api/operation/GET_PaymentParts).

          '
      - type: string
        in: path
        name: itempartid
        required: true
        description: 'The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](/api-references/api/operation/GET_PaymentItemParts).

          '
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/refunds:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRefunds a full or partial unapplied payment to your customers. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers.\n\nFor more information, see [Refund Payments](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Y_Refund_Payments).\n"
      summary: Refund a payment
      operationId: POST_RefundPayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a889e590e00c9
              number: R-00000001
              status: Processed
              type: External
              methodType: CreditCard
              accountId: 4028905f5a87c0ff015a87d25ae90025
              amount: 4
              refundDate: '2017-03-01'
              comment: Create a refund for unapplied payment.
              paymentGatewayNumber: PG-00000001
              paymentMethodId: null
              paymentMethodSnapshotId: null
              paymentId: 4028905f5a87c0ff015a889ddfb800c0
              creditMemoId: null
              reasonCode: Standard Refund
              gatewayId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondRefundReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 14:46:03'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:46:03'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              refundTransactionTime: null
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETRefundPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PostRefundType'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/unapply:
    put:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUnapplies an applied payment from invoices and debit memos.\n\nWhen you unapply a payment, the total number of invoice items and debit memo items that the payment will unapply from must be less than or equal to 15,000.\n\nIf the limit is hit, you can follow the instructions:\n- If you want to unapply one payment without specifying invoices or debit memos, you have to specify the invoices or debit memos in the request.\n- If you want to unapply one payment from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to unapply one payment from a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000.\n\nFor more information, see [Unapply Payments from Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Unapply_Payments_from_Invoices_and_Debit_Memos).\n"
      summary: Unapply a payment
      operationId: PUT_UnapplyPayment
      tags:
      - Payments
      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: 4028905f5a87c0ff015a87eb6b75007f
              number: P-00000001
              status: Processed
              type: External
              accountId: 4028905f5a87c0ff015a87d25ae90025
              accountNumber: A00000001
              amount: 44.1
              appliedAmount: 32.98
              unappliedAmount: 11.12
              refundAmount: 0
              creditBalanceAmount: 0
              currency: USD
              effectiveDate: '2017-03-01'
              comment: normal payment
              paymentGatewayNumber: PG-00000001
              paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
              paymentMethodSnapshotId: null
              authTransactionId: null
              bankIdentificationNumber: null
              gatewayId: null
              gatewayOrderId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondPaymentReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 11:30:37'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 13:53:12'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETARPaymentType'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/UnapplyPaymentType'
        description: ''
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
  /v1/payments/{paymentKey}/refunds/unapply:
    post:
      description: "**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRefunds a full or partial unapplied payment to your customers, without the need to unapply the payment first, followed by processing the refund. To refund applied payments, you can now leverage this API to unapply and refund the payment simultaneously.\n\nFor more information, see [Refund Payments](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Y_Refund_Payments).\n"
      summary: Refund a payment with auto-unapplying
      operationId: POST_RefundPaymentwithAutoUnapply
      tags:
      - Payments
      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: 4028905f5a87c0ff015a889e590e00c9
              number: R-00000001
              status: Processed
              type: External
              methodType: CreditCard
              accountId: 4028905f5a87c0ff015a87d25ae90025
              amount: 100
              refundDate: '2017-03-01'
              comment: Create a refund for unapplied payment.
              paymentGatewayNumber: PG-00000001
              paymentMethodId: null
              paymentMethodSnapshotId: null
              paymentId: 4028905f5a87c0ff015a889ddfb800c0
              creditMemoId: null
              reasonCode: Standard Refund
              gatewayId: null
              gatewayResponse: null
              gatewayResponseCode: null
              gatewayState: NotSubmitted
              markedForSubmissionOn: null
              referenceId: null
              secondRefundReferenceId: null
              softDescriptor: null
              softDescriptorPhone: null
              submittedOn: null
              settledOn: null
              cancelledOn: null
              createdDate: '2017-03-01 14:46:03'
              createdById: 402881e522cf4f9b0122cf5d82860002
              updatedDate: '2017-03-01 14:46:03'
              updatedById: 402881e522cf4f9b0122cf5d82860002
              refundTransactionTime: null
              financeInformation:
                bankAccountAccountingCode: null
                bankAccountAccountingCodeType: null
                unappliedPaymentAccountingCode: null
                unappliedPaymentAccountingCodeType: null
                transferredToAccounting: 'No'
              gatewayReconciliationStatus: null
              gatewayReconciliationReason: null
              payoutId: null
              success: true
          schema:
            $ref: '#/definitions/GETRefundPaymentTypeAutoUnapply'
      parameters:
      - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key'
      - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding'
      - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single'
      - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids'
      - name: body
        in: body
        required: true
        description: ''
        schema:
          $ref: '#/definitions/PostRefundwithAutoUnapplyType'
      - type: string
        in: path
        name: paymentKey
        required: true
        description: 'The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

          '
definitions:
  PaymentDebitMemoApplicationCreateRequestType:
    properties:
      amount:
        description: 'The amount of the payment associated with the debit memo.

          '
        format: double
        type: number
      debitMemoId:
        description: 'The unique ID of the debit memo that the payment is created on.

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


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentDebitMemoApplicationItemCreateRequestType'
        type: array
    required:
    - amount
    title: debitMemos
    type: object
  UnapplyPaymentType:
    example:
      debitMemos:
      - amount: 1.02
        debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
        items:
        - amount: 1
          debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
        - amount: 0.02
          taxItemId: 4028905f5a87c0ff015a87e49f5e0065
      effectiveDate: '2017-03-01'
      invoices:
      - amount: 10.1
        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
        items:
        - amount: 10
          invoiceItemId: 4028905f5a87c0ff015a87d3f90c0045
        - amount: 0.1
          taxItemId: 4028905f5a87c0ff015a87d3f884003f
    properties:
      debitMemos:
        description: 'Container for debit memos. The maximum number of debit memos is 1,000.

          '
        items:
          $ref: '#/definitions/PaymentDebitMemoApplicationUnapplyRequestType'
        type: array
      effectiveDate:
        description: 'The date when the payment is unapplied, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment.

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

          '
        items:
          $ref: '#/definitions/PaymentInvoiceApplicationUnapplyRequestType'
        type: array
    type: object
  GETPaymentPartType:
    properties:
      amount:
        description: 'The amount of the payment part.

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

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

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

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

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

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


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

          '
        type: string
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
      updatedById:
        description: 'The ID of the Zuora user who last updated the payment part.

          '
        type: string
      updatedDate:
        description: 'The date and time when the payment part 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
  GETRefundPaymentType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.

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

            '
          format: double
          type: number
        cancelledOn:
          description: "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. \n"
          format: date-time
          type: string
        comment:
          description: 'Comments about the refund.

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

            '
          type: string
        createdDate:
          description: "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. \n"
          format: date-time
          type: string
        creditMemoId:
          description: 'The ID of the credit memo associated with the refund.

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

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

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

                '
              type: string
            transferredToAccounting:
              description: "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

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

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

            '
          type: string
        gatewayReconciliationReason:
          description: 'The reason of gateway reconciliation.

            '
          type: string
        gatewayReconciliationStatus:
          description: 'The status of gateway reconciliation.

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

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

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

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

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

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

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

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


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

            '
          type: string
        paymentGatewayNumber:
          description: 'The natural key for the payment gateway.

            '
          type: string
        paymentId:
          description: 'The ID of the payment that is refunded.

            '
          type: string
        paymentMethodId:
          description: "The unique ID of the payment method that the customer used to make the refund. \n"
          type: string
        paymentMethodSnapshotId:
          description: 'The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.

            '
          type: string
        payoutId:
          description: 'The payout ID of the refund from the gateway side.

            '
          type: string
        reasonCode:
          description: "A code identifying the reason for the transaction. \n"
          type: string
        referenceId:
          description: 'The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

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

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

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

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

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

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

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

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

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

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

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

            '
          format: date-time
          type: string
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
  PaymentObjectNSFields:
    description: 'Container for Payment 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 payment''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 payment 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: paymentFieldsNS
    type: object
  PaymentWithCustomRatesType:
    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
  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
  RefundObjectNSFields:
    description: 'Container for Refund fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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

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

          '
        maxLength: 255
        type: string
      Origin__NS:
        description: 'Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

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

          '
        maxLength: 255
        type: string
      SynctoNetSuite__NS:
        description: 'Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

          '
        maxLength: 255
        type: string
    title: refundFieldsNS
    type: object
  PaymentDebitMemoApplicationItemCreateRequestType:
    properties:
      amount:
        description: 'The amount of the payment associated with the specific debit memo or taxation item.

          '
        format: double
        type: number
      debitMemoItemId:
        description: 'The ID of the specific debit memo item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PaymentInvoiceApplicationApplyRequestType:
    properties:
      amount:
        description: 'The amount that is applied from the payment to the invoice.

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

          '
        type: string
      invoiceNumber:
        description: "The number of the invoice that the payment is applied to. For example, `INV00000001`. \n\n**Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.\n"
        type: string
      items:
        description: 'Container for invoice items. The maximum number of items is 1,000.


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentInvoiceApplicationItemApplyRequestType'
        type: array
    required:
    - amount
    title: invoices
    type: object
  GETPaymentPartTypewithSuccess:
    properties:
      amount:
        description: 'The amount of the payment part.

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

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

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

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

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

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


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

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

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

          '
        format: date-time
        type: string
    title: parts
    type: object
  TransferPaymentType:
    example:
      accountId: 4028905f5a87c0ff015a88889fe500a8
    properties:
      accountId:
        description: 'The ID of the customer account that the payment is transferred to.

          Unassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account.

          '
        type: string
    type: object
  PaymentDebitMemoApplicationApplyRequestType:
    properties:
      amount:
        description: 'The amount that is applied from the payment to the debit memo.

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

          '
        type: string
      debitMemoNumber:
        description: 'The number of the debit memo that the payment is applied to.

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


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentDebitMemoApplicationItemApplyRequestType'
        type: array
    required:
    - amount
    title: debitMemos
    type: object
  GETARPaymentTypeWithPaymentOption:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account that the payment is for.

            '
          type: string
        accountNumber:
          description: 'The number of the customer account that the payment is for.

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

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

            '
          format: double
          type: number
        authTransactionId:
          description: 'The authorization transaction ID from the payment gateway.

            '
          type: string
        bankIdentificationNumber:
          description: 'The first six or eight digits of the credit card or debit card used for the payment, when applicable.

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

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

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

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

            '
          format: date-time
          type: string
        creditBalanceAmount:
          description: 'The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.

            '
          format: double
          type: number
        currency:
          description: 'When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

            '
          type: string
        effectiveDate:
          description: 'The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        financeInformation:
          description: 'Container for the finance information related to the payment.

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

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

                '
              type: string
            transferredToAccounting:
              description: "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

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

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

            '
          type: string
        gatewayOrderId:
          description: 'A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.  If not specified, the payment number will be passed in instead.

            '
          type: string
        gatewayReconciliationReason:
          description: 'The reason of gateway reconciliation.

            '
          type: string
        gatewayReconciliationStatus:
          description: 'The status of gateway reconciliation.

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

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

            '
          type: string
        gatewayState:
          description: 'The status of the payment in the gateway; use for reconciliation.

            '
          enum:
          - MarkedForSubmission
          - Submitted
          - Settled
          - NotSubmitted
          - FailedToSettle
          type: string
        id:
          description: 'The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

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

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

            '
          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
        paymentGatewayNumber:
          description: 'The natural key for the payment gateway.

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

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

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleKey:
          description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information.
          type: string
        payoutId:
          description: 'The payout ID of the payment from the gateway side.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        referenceId:
          description: 'The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          type: string
        refundAmount:
          description: 'The amount of the payment that is refunded.

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

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

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

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

            '
          type: string
        standalone:
          default: false
          description: 'This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.


            The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.


            The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.

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


            If the <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Asynchronous_payment_flow" target="_blank">Asynchronous Payment Statuses</a> feature is not enabled, possible values are `Draft`, `Processing`, `Processed`, `Error`, `Canceled`, and `Posted`.


            If the Asynchronous Payment Statuses feature is enabled, when the ACH or Bank Transfer payment is created, it is in a `Pending` status upon successful network communication with the gateway. To transition from a `Pending` status to another status, use one of our Gateway Reconciliation options or cancel the payment.

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

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

            '
          enum:
          - External
          - Electronic
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the payment.

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment 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/PaymentObjectNSFields'
    - $ref: '#/definitions/PaymentObjectCustomFields'
  RefundObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Refund object. The name of each custom field has the form <code>*customField*__c</code>. Custom field names are case sensitive. See [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.

        '
    description: 'Container for custom fields of a Refund object.

      '
    title: refundFieldsCustom
    type: object
  PaymentDebitMemoApplicationUnapplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is unapplied from the debit memo.

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

          '
        type: string
      debitMemoNumber:
        description: 'The number of the debit memo that the payment is unapplied from.

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


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentDebitMemoApplicationItemUnapplyRequestType'
        type: array
    required:
    - amount
    title: debitMemos
    type: object
  GETARPaymentTypewithSuccess:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account that the payment is for.

            '
          type: string
        accountNumber:
          description: 'The number of the customer account that the payment is for.

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

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

            '
          format: double
          type: number
        authTransactionId:
          description: 'The authorization transaction ID from the payment gateway.

            '
          type: string
        bankIdentificationNumber:
          description: 'The first six or eight digits of the credit card or debit card used for the payment, when applicable.

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

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

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

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

            '
          format: date-time
          type: string
        creditBalanceAmount:
          description: 'The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.

            '
          format: double
          type: number
        currency:
          description: 'When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

            '
          type: string
        effectiveDate:
          description: 'The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        financeInformation:
          description: 'Container for the finance information related to the payment.

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

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

                '
              type: string
            transferredToAccounting:
              description: "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

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

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

            '
          type: string
        gatewayOrderId:
          description: 'A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.

            '
          type: string
        gatewayReconciliationReason:
          description: 'The reason of gateway reconciliation.

            '
          type: string
        gatewayReconciliationStatus:
          description: 'The status of gateway reconciliation.

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

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

            '
          type: string
        gatewayState:
          description: "The status of the payment in the gateway; use for reconciliation. \n"
          enum:
          - MarkedForSubmission
          - Submitted
          - Settled
          - NotSubmitted
          - FailedToSettle
          type: string
        id:
          description: 'The unique ID of the payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

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

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

            '
          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
        paymentGatewayNumber:
          description: 'The natural key for the payment gateway.

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

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

            '
          type: string
        paymentOption:
          description: 'Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.


            `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.

            '
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleKey:
          description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information.
          type: string
        payoutId:
          description: 'The payout ID of the payment from the gateway side.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        referenceId:
          description: 'The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          type: string
        refundAmount:
          description: 'The amount of the payment that is refunded.

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

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

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

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

            '
          type: string
        standalone:
          default: false
          description: 'This field is only available if the support for standalone payment is enabled.


            The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.


            The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.

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

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

            '
          format: date-time
          type: string
        type:
          description: 'The type of the payment.

            '
          enum:
          - External
          - Electronic
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the payment.

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment 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/PaymentObjectNSFields'
    - $ref: '#/definitions/PaymentObjectCustomFields'
    title: payments
  GETPaymentItemPartTypewithSuccess:
    properties:
      amount:
        description: 'The amount of the payment part item.

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

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

          '
        format: date-time
        type: string
      debitMemoItemId:
        description: 'The ID of the debit memo item associated with the payment part item.

          '
        type: string
      id:
        description: 'The ID of the payment part item.

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

          '
        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
      taxItemId:
        description: 'The ID of the taxation item associated with the payment part item.

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

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

          '
        format: date-time
        type: string
    title: itemParts
    type: object
  PaymentInvoiceApplicationCreateRequestType:
    properties:
      amount:
        description: 'The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice.

          '
        format: double
        type: number
      invoiceId:
        description: 'The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`.

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


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentInvoiceApplicationItemCreateRequestType'
        type: array
    required:
    - amount
    title: invoices
    type: object
  PaymentInvoiceApplicationItemUnapplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is unapplied from the specific invoice or taxation item.

          '
        format: double
        type: number
      invoiceItemId:
        description: 'The ID of the specific invoice item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  GETPaymentPartsCollectionType:
    properties:
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      parts:
        description: 'Container for payment parts.

          '
        items:
          $ref: '#/definitions/GETPaymentPartTypewithSuccess'
        type: array
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  PaymentInvoiceApplicationItemApplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is applied to the specific invoice or taxation item.

          '
        format: double
        type: number
      invoiceItemId:
        description: 'The ID of the specific invoice item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PaymentInvoiceApplicationItemCreateRequestType:
    properties:
      amount:
        description: 'The amount of the payment associated with the specific invoice or taxation item.

          '
        format: double
        type: number
      invoiceItemId:
        description: 'The ID of the specific invoice item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PostRefundType:
    allOf:
    - properties:
        comment:
          description: 'Comments about the refund.

            '
          maxLength: 255
          minLength: 0
          type: string
        customRates:
          description: 'It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both).


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

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

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

                '
              maxLength: 100
              minLength: 0
              type: string
            transferredToAccounting:
              description: "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        gatewayOptions:
          description: 'The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

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

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

                '
              type: string
          type: object
        methodType:
          description: 'How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment.

            '
          enum:
          - ACH
          - Cash
          - Check
          - CreditCard
          - PayPal
          - WireTransfer
          - DebitCard
          - CreditCardReferenceTransaction
          - BankTransfer
          - Other
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.

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

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

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

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

            '
          enum:
          - External
          - Electronic
          type: string
      required:
      - totalAmount
      - type
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
    example:
      comment: Create a refund for unapplied payment.
      customRates:
      - currency: CAD
        customFxRate: 2.22
        rateDate: '2022-10-21'
      - currency: EUR
        customFxRate: 2.22
        rateDate: '2022-10-21'
      gatewayOptions:
        Comments: test
        IPAddress: 192.168.1.1
      methodType: CreditCard
      reasonCode: Standard Refund
      refundDate: '2017-03-01'
      totalAmount: 4
      type: External
  CreatePaymentType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account that the payment is created for.

            '
          type: string
        accountNumber:
          description: 'The number of the customer account that the payment is created for, such as `A00000001`.


            You can 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
        amount:
          description: 'The total amount of the payment.

            '
          format: double
          type: number
        authTransactionId:
          description: "The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards.\n\nWhen you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field.\n\nThe following payment gateways support this field:\n  - Adyen Integration v2.0\n  - CyberSource 1.28\n  - CyberSource 1.97\n  - CyberSource 2.0\n  - Chase Paymentech Orbital\n  - Ingenico ePayments\n  - SlimPay\n  - Stripe v2\n  - Verifi Global Payment Gateway\n  - WePay Payment Gateway Integration\n"
          maxLength: 50
          type: string
        comment:
          description: 'Additional information related to the payment.

            '
          maxLength: 255
          minLength: 0
          type: string
        currency:
          description: 'When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

            '
          type: string
        customRates:
          description: 'It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both).


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

            '
          items:
            $ref: '#/definitions/PaymentWithCustomRatesType'
          maxItems: 2
          type: array
        debitMemos:
          description: 'Container for debit memos. The maximum number of debit memos is 1,000.

            '
          items:
            $ref: '#/definitions/PaymentDebitMemoApplicationCreateRequestType'
          type: array
        effectiveDate:
          description: "The date when the payment takes effect, in `yyyy-mm-dd` format.\n\n**Note:**\n  - This field is required for only electronic payments. It's an optional field for external payments.\n  - When specified, this field must be set to the date of today.\n"
          format: date
          type: string
        financeInformation:
          description: 'Container for the finance information related to the payment.

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

                '
              maxLength: 100
              minLength: 0
              type: string
            transferredToAccounting:
              description: "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        gatewayId:
          description: "The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method. \n\n- When creating electronic payments, this field is required. \n- When creating external payments, this field is optional.\n\nUse the same gateway instance if both `paymentGatewayNumber` and `gatewayId` are sent in the request.\n"
          type: string
        gatewayOptions:
          description: 'The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

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

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

                '
              maxLength: 255
              type: string
          type: object
        gatewayOrderId:
          description: 'A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead.


            Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems.


            When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field.

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

            '
          items:
            $ref: '#/definitions/PaymentInvoiceApplicationCreateRequestType'
          type: array
        mitTransactionSource:
          description: "Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework.\n  - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates.\n  - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals.\n  - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates.\n  - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information.\n"
          enum:
          - C_Unscheduled
          - M_Recurring
          - M_Unscheduled
          - M_MOTO
          type: string
        paymentGatewayNumber:
          description: "The natural key for the payment gateway. \n\nUse the same gateway instance if both `paymentGatewayNumber` and `gatewayId` are sent in the request.\n"
          type: string
        paymentMethodId:
          description: "The unique ID of the payment method that the customer used to make the payment. \n\nIf no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs.\n"
          type: string
        paymentMethodType:
          default: null
          description: "The type of the payment method that the customer used to make the payment. \n\nSpecify this value when you are creating an external payment method. If both `paymentMethodType` and `paymentMethodId` are specified, only the `paymentMethodId` value is used to create the payment.\n"
          type: string
        paymentOption:
          description: "Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported.\n\nHere is an example:\n```\n\"paymentOption\": [\n  {\n    \"type\": \"GatewayOptions\",\n    \"detail\": {\n      \"SecCode\":\"WEB\"\n    }\n  }\n]\n```\n\n`paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item.\n\nYou can use this field or the `gatewayOptions` field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the `paymentOption` field will be stored in the Payment Option object and can be easily retrieved.\n"
          items:
            $ref: '#/definitions/PaymentSchedulePaymentOptionFields'
          type: array
        paymentScheduleKey:
          description: The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information.
          type: string
        prepayment:
          description: 'Indicates whether the payment will be used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        referenceId:
          description: 'The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          maxLength: 100
          minLength: 0
          type: string
        softDescriptor:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 35
          type: string
        softDescriptorPhone:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 20
          type: string
        standalone:
          default: false
          description: "This field is only available if support for standalone payments is enabled.\n\nSpecify `true` to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora.\n\nWhen `standalone` is set to `true`:\n  - `accountId`, `amount`, `currency`, and `type` are required. \n  - `type` must be `Electronic`.\n  - `currency` of the payment can be different from the payment currency in the customer account settings.\n  - The amount will not be summed up into the account balance and key metrics regardless of the payment currency.\n  - No settlement data will be created.\n  - Either the applied amount or the unapplied amount of the payment is zero.\n  - The standalone payment cannot be applied, unapplied, or transferred.\n\nSpecify `false` to create an ordinary payment that will be created, processed, and settled in Zuora. The `currency` of an ordinary payment must be the same as the currency in the customer account settings.\n"
          type: boolean
        type:
          description: 'The type of the payment.

            '
          enum:
          - External
          - Electronic
          type: string
      required:
      - amount
      - currency
      - type
      type: object
    - $ref: '#/definitions/PaymentObjectNSFields'
    - $ref: '#/definitions/PaymentObjectCustomFields'
    example:
      accountId: 4028905f5a87c0ff015a87d25ae90025
      amount: 44.1
      comment: normal payment
      currency: USD
      customRates:
      - currency: CAD
        customFxRate: 2.22
        rateDate: '2022-10-21'
      - currency: EUR
        customFxRate: 1.5
        rateDate: '2022-10-21'
      debitMemos:
      - amount: 4.1
        debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
        items:
        - amount: 4
          debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
        - amount: 0.1
          taxItemId: 4028905f5a87c0ff015a87e49f5e0065
      effectiveDate: '2017-03-01'
      invoices:
      - amount: 40
        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
        items:
        - amount: 39
          invoiceItemId: 4028905f5a87c0ff015a87d3f90c0045
        - amount: 1
          taxItemId: 4028905f5a87c0ff015a87d3f884003f
      paymentMethodId: 402881e522cf4f9b0122cf5dc4020045
      type: External
  GETPaymentItemPartType:
    properties:
      amount:
        description: 'The amount of the payment part item.

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

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

          '
        format: date-time
        type: string
      debitMemoItemId:
        description: 'The ID of the debit memo item associated with the payment part item.

          '
        type: string
      id:
        description: 'The ID of the payment part item.

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

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


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

          '
        type: string
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
      taxItemId:
        description: 'The ID of the taxation item associated with the payment part item.

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

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

          '
        format: date-time
        type: string
    type: object
  ApplyPaymentType:
    example:
      debitMemos:
      - amount: 1.02
        debitMemoId: 4028905f5a87c0ff015a87e49e6b0062
        items:
        - amount: 1
          debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063
        - amount: 0.02
          taxItemId: 4028905f5a87c0ff015a87e49f5e0065
      effectiveDate: '2017-03-01'
      invoices:
      - amount: 10.1
        invoiceId: 4028905f5a87c0ff015a87d3f8f10043
        items:
        - amount: 10
          invoiceItemId: 4028905f5a87c0ff015a87d3f90c0045
        - amount: 0.1
          taxItemId: 4028905f5a87c0ff015a87d3f884003f
    properties:
      debitMemos:
        description: 'Container for debit memos. The maximum number of debit memos is 1,000.

          '
        items:
          $ref: '#/definitions/PaymentDebitMemoApplicationApplyRequestType'
        type: array
      effectiveDate:
        description: 'The date when the payment application takes effect, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment.

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

          '
        items:
          $ref: '#/definitions/PaymentInvoiceApplicationApplyRequestType'
        type: array
    type: object
  PaymentDebitMemoApplicationItemApplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is applied to the specific debit memo or taxation item.

          '
        format: double
        type: number
      debitMemoItemId:
        description: 'The ID of the specific debit memo item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  GETARPaymentType:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the customer account that the payment is for.

            '
          type: string
        accountNumber:
          description: 'The number of the customer account that the payment is for.

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

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

            '
          format: double
          type: number
        authTransactionId:
          description: 'The authorization transaction ID from the payment gateway.

            '
          type: string
        bankIdentificationNumber:
          description: 'The first six or eight digits of the credit card or debit card used for the payment, when applicable.

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

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

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

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

            '
          format: date-time
          type: string
        creditBalanceAmount:
          description: 'The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature.

            '
          format: double
          type: number
        currency:
          description: 'When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI.


            When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency.

            '
          type: string
        effectiveDate:
          description: 'The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format.

            '
          format: date-time
          type: string
        financeInformation:
          description: 'Container for the finance information related to the payment.

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

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

                '
              type: string
            transferredToAccounting:
              description: "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

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

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

            '
          type: string
        gatewayOrderId:
          description: 'A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created.  If not specified, the payment number will be passed in instead.

            '
          type: string
        gatewayReconciliationReason:
          description: 'The reason of gateway reconciliation.

            '
          type: string
        gatewayReconciliationStatus:
          description: 'The status of gateway reconciliation.

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

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

            '
          type: string
        gatewayState:
          description: 'The status of the payment in the gateway; use for reconciliation.

            '
          enum:
          - MarkedForSubmission
          - Submitted
          - Settled
          - NotSubmitted
          - FailedToSettle
          type: string
        id:
          description: 'The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f.

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

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

            '
          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
        paymentGatewayNumber:
          description: 'The natural key for the payment gateway.

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

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

            '
          type: string
        paymentScheduleKey:
          description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information.
          type: string
        payoutId:
          description: 'The payout ID of the payment from the gateway side.

            '
          type: string
        prepayment:
          description: 'Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information.

            '
          type: boolean
        referenceId:
          description: 'The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.

            '
          type: string
        refundAmount:
          description: 'The amount of the payment that is refunded.

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

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

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

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

            '
          type: string
        standalone:
          default: false
          description: 'This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment.


            The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred.


            The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora.

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

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

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

            '
          enum:
          - External
          - Electronic
          type: string
        unappliedAmount:
          description: 'The unapplied amount of the payment.

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

            '
          type: string
        updatedDate:
          description: 'The date and time when the payment 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/PaymentObjectNSFields'
    - $ref: '#/definitions/PaymentObjectCustomFields'
  PostRefundwithAutoUnapplyType:
    allOf:
    - properties:
        comment:
          description: 'Comments about the refund.

            '
          maxLength: 255
          minLength: 0
          type: string
        debitMemos:
          description: 'Container for debit memos. The maximum number of debit memos is 1,000.

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

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

                '
              maxLength: 100
              minLength: 0
              type: string
            transferredToAccounting:
              description: "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        gatewayOptions:
          description: 'The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways).


            Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

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

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

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

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

            '
          enum:
          - ACH
          - Cash
          - Check
          - CreditCard
          - PayPal
          - WireTransfer
          - DebitCard
          - CreditCardReferenceTransaction
          - BankTransfer
          - Other
          type: string
        reasonCode:
          description: 'A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code.

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

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

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

            '
          maxLength: 100
          minLength: 0
          type: string
        softDescriptor:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 35
          type: string
        softDescriptorPhone:
          description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi.
          maxLength: 20
          type: string
        totalAmount:
          description: "The total amount of the refund. If you do not specify a value, Zuora initiates a full refund of the payment amount, which is the sum of the applied and unapplied payment amounts.\n\n  - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund.\n  - `Partial Refund`:\n       - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer.\n       - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers.  \n"
          format: double
          type: number
        type:
          description: 'The type of the refund.

            '
          enum:
          - External
          - Electronic
          type: string
        writeOff:
          default: false
          description: 'Indicates whether to write off a document.


            **Note:** If you want to have access to this feature, submit a request at [Zuora Global Support](http://support.zuora.com/).

            '
          type: boolean
        writeOffOptions:
          default: false
          description: 'Container for the write-off information to create credit memo.


            **Note:** If you want to have access to this feature, submit a request at [Zuora Global Support](http://support.zuora.com/).

            '
          properties:
            comment:
              description: 'Comments about the credit memo which is created as a result of the write off.

                '
              maxLength: 100
              type: string
            memoDate:
              description: 'The date when the credit memo takes effect.

                '
              format: date
              type: string
            reasonCode:
              description: 'A code identifying the reason for the credit memo.

                '
              type: string
          type: object
      required:
      - type
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
    example:
      comment: Create a refund for unapplied payment.
      gatewayOptions:
        Comments: test
        IPAddress: 192.168.1.1
      methodType: CreditCard
      reasonCode: Standard Refund
      refundDate: '2017-03-01'
      totalAmount: 100
      type: External
  PaymentCollectionResponseType:
    properties:
      nextPage:
        description: 'URL to retrieve the next page of the response if it exists; otherwise absent.

          '
        format: URL
        type: string
      payments:
        description: 'Container for payments.

          '
        items:
          $ref: '#/definitions/GETARPaymentTypewithSuccess'
        type: array
      success:
        description: Returns `true` if the request was processed successfully.
        type: boolean
    type: object
  PaymentSchedulePaymentOptionFields:
    properties:
      detail:
        description: 'The field used to pass the transactional payment data to the gateway side in the key-value format.

          '
        properties:
          key:
            description: 'The name of the field.

              '
            type: string
          value:
            description: 'The value of the field.

              '
            type: string
        type: object
      type:
        description: 'The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway.

          '
        type: string
    title: paymentOption
    type: object
  GETRefundPaymentTypeAutoUnapply:
    allOf:
    - properties:
        accountId:
          description: 'The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment.

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

            '
          format: double
          type: number
        cancelledOn:
          description: "The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. \n"
          format: date-time
          type: string
        comment:
          description: 'Comments about the refund.

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

            '
          type: string
        createdDate:
          description: "The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. \n"
          format: date-time
          type: string
        creditMemoId:
          description: 'The ID of the credit memo associated with the refund.

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

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

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

                '
              type: string
            transferredToAccounting:
              description: "Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

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

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

            '
          type: string
        gatewayReconciliationReason:
          description: 'The reason of gateway reconciliation.

            '
          type: string
        gatewayReconciliationStatus:
          description: 'The status of gateway reconciliation.

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

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

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

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

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

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

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

            '
          type: string
        paymentGatewayNumber:
          description: 'The natural key for the payment gateway.

            '
          type: string
        paymentId:
          description: 'The ID of the payment that is refunded.

            '
          type: string
        paymentMethodId:
          description: "The unique ID of the payment method that the customer used to make the refund. \n"
          type: string
        paymentMethodSnapshotId:
          description: 'The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction.

            '
          type: string
        payoutId:
          description: 'The payout ID of the refund from the gateway side.

            '
          type: string
        reasonCode:
          description: "A code identifying the reason for the transaction. \n"
          type: string
        referenceId:
          description: 'The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments.

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

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

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

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

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

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

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

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

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

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

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

            '
          format: date-time
          type: string
        writeOffResults:
          description: 'Container for the write-off information of credit memo and apply information.


            **Note:** If you want to have access to this feature, submit a request at [Zuora Global Support](http://support.zuora.com/).

            '
          properties:
            errorMessage:
              description: 'The error message about write off failed.

                '
              type: string
            transactions:
              description: 'The credit memo apply information.

                '
              properties:
                appliedAmount:
                  description: 'The credit memo applied amopunt.

                    '
                  format: double
                  type: number
                creditMemoAmount:
                  description: 'The credit memo amount.

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

                    '
                  type: string
                creditMemoStatus:
                  description: "The status of the credit memo. \n"
                  enum:
                  - Draft
                  - Posted
                  - Canceled
                  - Error
                  - PendingForTax
                  - Generating
                  - CancelInProgress
                  type: string
                invoiceNumber:
                  description: 'The unique identification number of the invoice.

                    '
                  type: string
              title: transactions
              type: object
          type: object
      type: object
    - $ref: '#/definitions/RefundObjectNSFields'
    - $ref: '#/definitions/RefundObjectCustomFields'
  PaymentDebitMemoApplicationItemUnapplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is unapplied from the specific debit mem or taxation item.

          '
        format: double
        type: number
      debitMemoItemId:
        description: 'The ID of the specific debit memo item.

          '
        type: string
      taxItemId:
        description: 'The ID of the specific taxation item.

          '
        type: string
    required:
    - amount
    title: items
    type: object
  PaymentObjectCustomFields:
    additionalProperties:
      description: 'Custom fields of the Payment 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 Payment object.

      '
    title: paymentFieldsCustom
    type: object
  GETPaymentItemPartCollectionType:
    properties:
      itemParts:
        description: 'Container for payment part items.

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

            '
          maxLength: 255
          minLength: 0
          type: string
        financeInformation:
          description: 'Container for the finance information related to the payment.


            For a standalone payment, the finance information cannot be updated.

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

                '
              maxLength: 100
              minLength: 0
              type: string
            transferredToAccounting:
              description: "Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. \n"
              enum:
              - Processing
              - 'Yes'
              - 'No'
              - Error
              - Ignore
              type: string
            unappliedPaymentAccountingCode:
              description: 'The accounting code for the unapplied payment.

                '
              maxLength: 100
              minLength: 0
              type: string
          type: object
        gatewayState:
          description: 'This field is mainly used for gateway reconciliation. See <a href="https://knowledgecenter.zuora.com/Zuora_Payments/Payment_Operations/DA_Electronic_Payment_Processing#Gateway_Reconciliation_Consideration" target="_blank">Electronic payment processing</a> for details.


            You must have the **Edit Payment Gateway Status** <a href="https://knowledgecenter.zuora.com/Zuora_Central_Platform/Tenant_Management/A_Administrator_Settings/User_Roles/e_Payments_Roles" target="_blank">user permission</a> to update this field.

            '
          enum:
          - NotSubmitted
          - Submitted
          - Settled
          - FailedToSettle
          type: string
        paymentScheduleKey:
          description: The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information.
          type: string
        referenceId:
          description: 'The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments.


            You can only update the reference ID for external payments.

            '
          maxLength: 100
          minLength: 0
          type: string
      type: object
    - $ref: '#/definitions/PaymentObjectNSFields'
    - $ref: '#/definitions/PaymentObjectCustomFields'
    example:
      comment: new comment
      financeInformation:
        transferredToAccounting: 'No'
  PaymentInvoiceApplicationUnapplyRequestType:
    properties:
      amount:
        description: 'The amount of the payment that is unapplied from the invoice.

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

          '
        type: string
      invoiceNumber:
        description: "The number of the invoice that the payment is unapplied from. For example, `INV00000001`. \n\n**Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.\n"
        type: string
      items:
        description: 'Container for invoice items. The maximum number of items is 1,000.


          **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos).  If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.

          '
        items:
          $ref: '#/definitions/PaymentInvoiceApplicationItemUnapplyRequestType'
        type: array
    required:
    - amount
    title: invoices
    type: object
parameters:
  GLOBAL_HEADER_Accept_Encoding:
    name: Accept-Encoding
    in: header
    required: false
    type: string
    description: "Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n"
  GLOBAL_HEADER_Zuora_Org_Ids:
    name: Zuora-Org-Ids
    in: header
    required: false
    type: string
    description: "Comma separated IDs. If you have <a href=\"https://knowledgecenter.zuora.com/Zuora_Central_Platform/Multi-Org\" target=\"_blank\">Zuora Multi-Org</a> enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.\n\nIf the header is not set, the operation is performed in scope of the user's accessible orgs.\n"
  GLOBAL_HEADER_Idempotency_Key:
    name: Idempotency-Key
    in: header
    required: false
    type: string
    maxLength: 255
    description: "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n"
  GLOBAL_HEADER_Content_Encoding:
    name: Content-Encoding
    in: header
    required: false
    type: string
    description: 'Include the `Content-Encoding: gzip` header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

      '
  GLOBAL_HEADER_Zuora_Entity_Ids_Single:
    name: Zuora-Entity-Ids
    in: header
    required: false
    type: string
    description: 'An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

      '
  GLOBAL_HEADER_Zuora_Track_Id:
    name: Zuora-Track-Id
    in: header
    required: false
    type: string
    maxLength: 64
    description: 'A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.


      The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (`:`), semicolon (`;`), double quote (`"`), and quote (`''`).

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

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

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

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