swagger: '2.0' info: version: '2023-12-15' title: API Reference 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](https://developer.zuora.com/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](https://developer.zuora.com/api-references/revenue/overview/)\n\ \ * [Collections API Reference](https://developer.zuora.com/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? Tell us how you feel 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](https://developer.zuora.com/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 Zuora Global Support 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\ \ https://www.zuora.com/resource/zuora-test-drive 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](https://developer.zuora.com/api-references/api/tag/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\n\ The 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```\n\ The `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\"Zuora\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](https://developer.zuora.com/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 Resource Codes 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 Zuora Global Support 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. |

Resubmit the request first to have another try.

\ \

If this error still occurs, contact Zuora Global Support with the returned `Zuora-Request-Id`\ \ value in the response header for assistance.

|\n| 60 | Internal error\ \ | The server encounters an internal error. | Contact Zuora Global Support 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. |

Resubmit the request\ \ first to have another try.

If this error still occurs, contact Zuora Global Support with the\ \ returned `Zuora-Request-Id` value in the response header for assistance.

|\n\ | 70 | Request exceeded limit | The total number of concurrent requests\ \ exceeds the limit allowed by the system. |

Resubmit the request after the\ \ number of seconds specified by the `Retry-After` value in the response header.

\ \

Check [Concurrent request limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/)\ \ for details about Zuora\u2019s concurrent request limit policy.

|\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](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/POST_Account\ \ \"Create Account\")|Generates an invoice and collects a payment for a subscription.\ \ |\n| collect | 196.0 and later | [Create Subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/POST_Account\ \ \"Create Account\")|Collects an automatic payment for a subscription. |\n| invoice\ \ | 196.0 and 207.0| [Create Subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/POST_Account\ \ \"Create Account\")|Generates an invoice for a subscription. |\n| invoiceTargetDate\ \ | 206.0 and earlier | [Preview Subscription](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription\ \ \"Preview Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription\ \ \"Preview Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription\ \ \"Preview Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription\ \ \"Preview Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_Subscription\ \ \"Create Subscription\"); [Update Subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription\ \ \"Update Subscription\"); [Renew Subscription](https://developer.zuora.com/api-references/api/operation/PUT_RenewSubscription\ \ \"Renew Subscription\"); [Cancel Subscription](https://developer.zuora.com/api-references/api/operation/PUT_CancelSubscription\ \ \"Cancel Subscription\"); [Suspend Subscription](https://developer.zuora.com/api-references/api/operation/PUT_SuspendSubscription\ \ \"Suspend Subscription\"); [Resume Subscription](https://developer.zuora.com/api-references/api/operation/PUT_ResumeSubscription\ \ \"Resume Subscription\"); [Create Account](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc\ \ \"Create debit memo from charge\") | Amount of the memo item. |\n| subscriptionNumbers\ \ | 222.4 and earlier | [Create order](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems\ \ \"Get credit memo items\"); [Get credit memo item](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems\ \ \"Get debit memo items\"); [Get debit memo item](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems\ \ \"Get credit memo items\"); [Get credit memo item](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItem\ \ \"Get credit memo item\"); [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems\ \ \"Get debit memo items\"); [Get debit memo item](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc\ \ \"Create debit memo from charge\"); [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice\ \ \"Create credit memo from invoice\"); [Create debit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice\ \ \"Create debit memo from invoice\"); [Get credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems\ \ \"Get credit memo items\"); [Get credit memo item](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItem\ \ \"Get credit memo item\"); [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems\ \ \"Get debit memo items\"); [Get debit memo item](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc\ \ \"Create credit memo from charge\"); [Create debit memo from charge](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromPrpc\ \ \"Create debit memo from charge\"); [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice\ \ \"Create credit memo from invoice\"); [Create debit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_DebitMemoFromInvoice\ \ \"Create debit memo from invoice\"); [Get credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems\ \ \"Get credit memo items\"); [Get credit memo item](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItem\ \ \"Get credit memo item\"); [Get debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems\ \ \"Get debit memo items\"); [Get debit memo item](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription\ \ \"Preview a subscription\"); [Update a subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/api-references/api/operation/POST_PaymentSchedule\ \ \"Create a payment schedule\"); [Create multiple payment schedules at once](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_AddItemsToCustomPaymentSchedule/\ \ \"Add payment schedule items to a custom payment schedule\"); [Update a payment\ \ schedule](https://developer.zuora.com/api-references/api/operation/PUT_PaymentSchedule/\ \ \"Update a payment schedule\"); [Update a payment schedule item](https://developer.zuora.com/api-references/api/operation/PUT_PaymentScheduleItem/\ \ \"Update a payment schedule item\"); [Preview the result of payment schedule\ \ update](https://developer.zuora.com/api-references/api/operation/PUT_PaymentScheduleUpdatePreview/\ \ \"Preview the result of payment schedule update\"); [Retrieve a payment schedule](https://developer.zuora.com/api-references/api/operation/GET_PaymentSchedule/\ \ \"Retrieve a payment schedule\"); [Retrieve a payment schedule item](https://developer.zuora.com/api-references/api/operation/GET_PaymentScheduleItem/\ \ \"Retrieve a payment schedule item\"); [List payment schedules by customer account](https://developer.zuora.com/api-references/api/operation/GET_PaymentSchedules/\ \ \"List payment schedules by customer account\"); [Cancel a payment schedule](https://developer.zuora.com/api-references/api/operation/PUT_CancelPaymentSchedule/\ \ \"Cancel a payment schedule\"); [Cancel a payment schedule item](https://developer.zuora.com/api-references/api/operation/PUT_CancelPaymentScheduleItem/\ \ \"Cancel a payment schedule item\");[Skip a payment schedule item](https://developer.zuora.com/api-references/api/operation/PUT_SkipPaymentScheduleItem/\ \ \"Skip a payment schedule item\");[Retry failed payment schedule items](https://developer.zuora.com/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](https://developer.zuora.com/api-references/api/operation/POST_PreviewSubscription)\ \ and [Update Subscription](https://developer.zuora.com/api-references/api/operation/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](https://developer.zuora.com/rest-api/general-concepts/object-model/).\n\ \nYou can use the [Describe](https://developer.zuora.com/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 |

`BillingRun` - API\ \ name used in the [Describe](https://developer.zuora.com/api-references/api/operation/GET_Describe)\ \ operation, Export ZOQL queries, and Data Query.

`BillRun` - API name\ \ used in the [Actions](https://developer.zuora.com/api-references/api/tag/Actions).\ \ See the CRUD oprations of [Bill Run](https://developer.zuora.com/api-references/api/tag/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 schemes: - https basePath: / produces: - application/json consumes: - application/json 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 tags: - name: Actions description: | Actions are operations that are batch in nature. For example, the "create", "update", "delete", and other operations allow changes to up-to 50 objects at a time. The "query" operation will return up-to 2000 result records back at a time, before requiring additional pages of data to be returned via a subsequent "queryMore" operation. The default WSDL version for Actions is 79. If you want to change the WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which WSDL version a particular object or field was introduced, see [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History). **Note**: Actions do not support the Invoice Settlement feature. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. Actions also do not support the Orders feature. - name: Accounting Codes description: "Accounting Codes are commonly referred to as General Ledger Accounts\ \ or General Ledger Account Codes. In Zuora, the use of accounting codes are optional\ \ but recommended. \n\nThis section contains the operations that allow you to\ \ create, update, get, delete, activate, or deactivate accounting codes in Zuora.\n" - name: Accounting Periods description: "A key step in configuring Finance is to create accounting periods\ \ in Zuora to match your company's financial calendar. \nThis allows Zuora to\ \ produce reports and data exports organized by accounting periods, and to perform\ \ the work of closing the accounting periods for the revenue sub-ledger.\n" - name: Accounts description: | Some operations in this section are similar to each other, but are provided for different use scenarios. You should choose the one that best suits your needs. For example, the [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation is used to create an account with a credit card payment method, a bill-to contact, and optionally an sold-to contact or an associated subscription. If you want to create an account without creating any associated objects such as subscriptions, use [CRUD: Create Account](https://developer.zuora.com/api-references/api/operation/Object_POSTAccount) instead. If you want to create an account and the associated subscription at the same time without providing credit card information, use the [Subscribe](https://developer.zuora.com/api-references/api/operation/Action_POSTsubscribe) action. - name: Delivery Adjustments description: "Delivery Adjustments are used to handle end customer delivery complaints\ \ for the Delivery Pricing charge model. For more information, see Delivery Adjustments. \n" - name: Aggregate Queries description: "The Aggregate Query API (AQuA) is a REST API that executes multiple\ \ Export ZOQL or ZOQL queries. The queries are performed in a sequential\ \ order and in a single read-only database transaction. \n\nAQuA enforces the\ \ following limits:\n\n- The maximum processing time per query is 3 hours. If\ \ a query in an AQuA job is executed for longer than 3 hours, this job will be\ \ killed automatically. See the best practices for bulk data extraction with AQuA.\n\n\ - AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless\ \ concurrent AQuA jobs per tenant:\n\n - The maximum number of stateful concurrent\ \ AQuA jobs per tenant is 50.\n - The maximum number of stateless concurrent\ \ AQuA jobs per tenant is 50.\n\n AQuA jobs in the following status are counted\ \ towards your concurrent AQuA job limits:\n\n - Submitted\n - Executing\n\ \n Zuora system will reject the subsequent stateful or stateless job requests\ \ once the corresponding concurrent job limit is reached.\n\nFor more information\ \ about the Aggregate Query API(AQuA), see Aggregate Query. \n" - name: API Health description: 'Zuora System Health dashboard for API (API dashboard) collects and displays data about API usage, failure, performance, and concurrency limit in near real time. It enables you to view all the APIs in your Zuora tenant within the last 14 days. For more information, see APIs dashboard. ' - name: Attachments description: "Use attachments in Zuora to upload documents of various formats to\ \ associate additional information with accounts, subscriptions, invoices, credit\ \ memos, or debit memos. \nExample attachments could be purchase orders (PO's),\ \ tax exemption document, or ownership transfer forms.\n\nFor more information\ \ about attachments, see Attachments.\n" - name: Bill Run Health description: 'Zuora System Health dashboard for Bill Run (Bill Run dashboard) collects and displays data about bill run usage, failure, and performance in near real time. Through the Bill Run dashboard, you can view data about all the bill runs in your Zuora tenant within the last 30 days. For more information, see Bill Run dashboard. ' - name: Bill Run description: "Use the Bill Run call to create ad hoc bill runs and Post, Cancel,\ \ Query, and Delete bill runs. \n\nFor more information about bill runs, see Bill runs.\n" - name: Billing Documents description: "Billing documents include invoices, credit memos, and debit memos.\ \ \n\n**Note**: Credit memos and debit memos are only available if you have the\ \ Invoice Settlement feature enabled. \n" - name: Billing Preview Run description: "A billing preview run asynchronously generates a downloadable CSV\ \ file containing a preview of future invoice item data and credit memo item data\ \ for a batch of customer accounts. \n\n**Note**: Credit memo item data is only\ \ available if you have the Invoice Settlement feature enabled. \n" - name: Catalog description: "The Zuora Billing product catalog is where you define your products\ \ and pricing. The product catalog's ability to handle sophisticated pricing models\ \ gives you the power to easily adapt your pricing to customer and market needs,\ \ to grow your business and drive more revenue. \n" - name: Catalog Groups description: 'A catalog group is used to group a list of product rate plans with a specific grade. ' - name: Configuration Templates description: "Configuration Templates in Zuora Deployment Manager enable you to\ \ configure your tenants in minutes by importing a templated metadata configuration\ \ file. This feature eliminates the need for long manual configuration processes\ \ that would have previously taken hours. You will be able to access a comprehensive\ \ repository of industry-specific templates. It will be easier for you to deploy\ \ and release. \n" - name: Contact Snapshots description: 'Every time a contact is updated a snapshot is taken. ' - name: Contacts description: 'A contact defines the customer who holds an account or who is otherwise a person to contact about an account. An account requires a contact for the `BillToId` and `SoldToId` fields before the account can be active. ' - name: Credit Memos description: | Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way that applying a payment to an invoice. For more information about credit memos, see Credit and debit memos. - name: Custom Event Triggers description: | The Event Trigger service manages the business events and trigger conditions that are defined on [Zuora Business Object Model](http://knowledgecenter.zuora.com/BB_Introducing_Z_Business/D_Zuora_Business_Objects_Relationship) or custom objects. When a Zuora object changes, the trigger conditions defined on the object are evaluated, and if any condition qualifies, a business event will be triggered and turned into a notification. **Note**: Event Triggers operations are only applicable to custom events. - name: Custom Exchange Rates description: "If you use a custom exchange rate provider and upload rates with the\ \ Import Foreign Exchange Rates mass action, you can query custom foreign exchange\ \ rates from Zuora through API. \n\nThis feature is in **Limited Availability**.\ \ If you wish to have access to the feature, submit a request at Zuora Global Support.\n" - name: Custom Object Definitions description: "With Custom Objects service, you can define custom objects, extending\ \ the Zuora data model to accommodate your specific use cases.\n\nIf you use Postman,\ \ you can import the custom objects endpoints as a collection into your Postman\ \ app and try out different requests to learn how the API works. Click the following\ \ button to get started:\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1f068ba43651bf63c0d4)\n\ \nYou can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup)\ \ and download the app in case you do not use Postman yet.\n\nNote that the Custom\ \ Object Definitions API is versioned by `Zuora-Version` in the request header.\ \ The response may be different for the same request with a different API version.\ \ Specify `Zuora-Version` in the request header if you expect a specific response\ \ schema.\n\n### Error handling \nIf the Custom Objects API call fails, an\ \ error code will be returned in the response body. See [Custom Objects API error\ \ code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code)\ \ for details.\n" - name: Custom Object Records description: "With Custom Objects service, you can create, update, delete and find\ \ custom object records.\n\nIf you use Postman, you can import the custom objects\ \ endpoints as a collection into your Postman app and try out different requests\ \ to learn how the API works. Click the following button to get started:\n\n[![Run\ \ in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1f068ba43651bf63c0d4)\n\ \nYou can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup)\ \ and download the app in case you do not use Postman yet.\n\nNote that the Custom\ \ Object Records API is versioned by `Zuora-Version` in the request header. The\ \ response may be different for the same request with a different API version.\ \ Specify `Zuora-Version` in the request header if you expect a specific response\ \ schema.\n\n### Error handling \nIf the Custom Objects API call fails, an\ \ error code will be returned in the response body. See [Custom Objects API error\ \ code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code)\ \ for details.\n" - name: Custom Object Jobs description: "With Custom Objects service, you can submit a bulk job request to\ \ create, update, or delete custom object records in a batch.\n\nIf you use Postman,\ \ you can import the custom objects endpoints as a collection into your Postman\ \ app and try out different requests to learn how the API works. Click the following\ \ button to get started:\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1f068ba43651bf63c0d4)\n\ \nYou can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup)\ \ and download the app in case you do not use Postman yet.\n\nNote that the Custom\ \ Object Jobs API is versioned by `Zuora-Version` in the request header. The response\ \ may be different for the same request with a different API version. Specify\ \ `Zuora-Version` in the request header if you expect a specific response schema.\n\ \n### Error handling \nIf the Custom Objects API call fails, an error code\ \ will be returned in the response body. See [Custom Objects API error code](https://knowledgecenter.zuora.com/Central_Platform/Custom_Objects/Z_Custom_Objects_API#Custom_Objects_API_error_code)\ \ for details.\n" - name: Custom Payment Method Types description: | Open Payment Method (OPM) service is a framework developed by Zuora, which allows you to integrate your custom payment method to Zuora subscription, billing, and revenue management in a dynamic and flexible manner. With the support of the OPM service, you are able to define your custom payment method types and create custom payment methods of the defined types. The custom payment method of the defined type can only be used with the custom payment gateway that you set up through the Universal Payment Connector (UPC) service. It cannot be used with the Zuora out-of-box gateway integrations such as GoCardless, Stripe, etc. You can define up to 20 custom payment method types for one tenant. Do not define your fields with the [Zuora-reserved fields](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods/C_Configure_and_manage_your_custom_payment_method_types_through_Zuora_REST_APIs#Zuora-reserved_fields). See [Set up custom payment gateways and payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) for more information about the OPM and UPC services. Note: You can only use the bearer token to access the "Custom Payment Method Types" API operations. Access with `apiAccessKeyId` and `apiSecretAccessKey` is not supported. - name: Custom Scheduled Events description: | A custom scheduled event notification is evaluated at the scheduled time of the related scheduled event on a daily basis. If the date meets the combination of the base field and the notification parameters, the notification will be triggered immediately. For more information about Custom Scheduled Events, see Custom Scheduled Events. - name: Data Labeling description: "The Data Labeling APIs help you to label your existing data with organization(s)\ \ in Zuora. \n\nOnce you turned on Multi Org feature, if you don't label your\ \ existing data, they are simply unlabeled, and unlabeled data can be accessed\ \ by all organizations in your tenant.\n\nTo limit the access of your existing\ \ data, you need to label them with organization(s) you defined in the organization\ \ hierarchy management setting page. Once labeled, the data can only be accessed\ \ by users who have been granted with the labeled organization(s).\n\nNote that\ \ you have to enable the \"Multi Org\" feature before using the Data Labeling\ \ APIs. \n\n### General guidelines\n\n* Firstly, create the org hierarchy and\ \ determine the data categorization strategy, for example, by currency, by region,\ \ by custom fields etc.\n\n* You have to migrate all customer accounts before\ \ labeling products in the product catalog\n\n* You can leave the users at the\ \ root, just so long as you understand that the user would have access to all\ \ the Org Units within the Multi-org enabled tenant\n\n* Currently, you need to\ \ manually label existing Journal Runs, JournalEntry, and AccountingPeriod objects\ \ by editing, tell us your use case if you want to automate this process.\n\n\ ### Order of object labeling\n\nExcept for `Account` and `Product`, there are\ \ no dependencies between objects, users can label them in parallel.\n\nBut please\ \ keep in mind that the data access control ensues from the object labeling. For\ \ example, if you label a scheduled `BillRun` with `US` org, when it's triggered\ \ next time, the bill run will only pick up customer accounts of the `US` org,\ \ not others.\n\nLikewise, labeling a user will change the user's visible data\ \ scope, for example, an `EU` user won't be able to see `US` accounts anymore.\n" - name: Data Queries description: 'The Data Query feature enables you to perform SQL queries in your Zuora tenant. To learn how to get started with Data Query, see [Overview of Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/A_Overview_of_Data_Query). ' - name: Debit Memos description: | Debit memos increase the amount a customer owes. It is a separate document from the invoice. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo. For more information about debit memos, see Credit and debit memos. - name: Describe description: | You can use the [Describe an object](https://www.zuora.com/redocly-test/api-references/api/operation/GET_Describe/) operation to get a reference listing of each object that is available in your Zuora tenant. By default, the information returned by the "Describe an object" operation corresponds to the latest version of the Zuora WSDL. - name: E-Invoicing description: "With the E-Invoicing feature, Zuora supports electronic invoices\ \ through an integration with partners that have a local presence, where required,\ \ which guarantees compliance with local invoice regulations. \n\nAll the operations\ \ in this section are available only if you have the E-Invoicing feature enabled.\n" - name: Electronic Payments Health description: 'Zuora System Health dashboard for Electronic Payments (Electronic Payment dashboard) collects and displays usage, failure, and performance data about electronic payments in near real time. It enables you to view all the electronic payments in your Zuora tenant within the last 30 days. For more information, see Electronic Payments dashboard. ' - name: Files description: 'You can use the operations contained in this section to retrieve files such as export results, invoices, accounting period reports, and so on. ' - name: Fulfillments description: "Fulfillments are subordinate objects attached to their related order\ \ line item. Fulfillment items are subordinate objects attached to their related\ \ fulfillment. \n\nFor more information, see Overview of Order Line Items. \n" - name: Hosted Pages description: "Hosted payment pages allow your customers to set up a payment method,\ \ such as providing a credit card. Since it only handles the payment method, it\ \ is suitable for a simple workflow or a complex multi-page, multi-product workflow.\ \ \n\nFor more information, see Hosted Payment Pages.\n" - name: Imports description: "An import uploads content, especially when you have a large amount\ \ of content. The Import object contains all of the information you need to upload\ \ content, such as a large number of usage records. \n" - name: Invoice Schedules description: "Use invoice schedules to trigger invoice generation processes. \n\n\ For more information about invoice schedules, see Billing Schedule overview.\n" - name: Invoices description: "Invoices provides information about customers' accounts for invoices,\ \ for examples, dates, status, and amounts. \n\nFor more information about invoices,\ \ see Invoice.\n" - name: Journal Runs description: | Use journal runs to automatically create summary journal entities that are suitable for importing into your general ledger system. For more information about journal runs, see Journal Runs. - name: Mass Updater description: | Use mass updater to perform mass actions more easily. For more information about mass updater, see Mass Updater. - name: Notifications description: | Notifications are the actions taken to inform users or call third-party endpoints when a certain event happens. Typical actions include emails and callouts. Callouts typically refer to HTTP invocations, such as HTTP calls to REST services. **NOTE:** Notifications are processed asynchronously and may be delivered with a delay and out of order. Notifications are associated with Communication Profiles, which allow you to send specific event-driven notifications to targeted customers. Zuora provides the following Settings API to access the settings of Communication Profiles: * [Get all Communication Profiles](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Communication_Profiles) * [Create a new Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Create_a_new_Communication_Profile) * [Modify a Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Modify_a_Communication_Profile) * [Get all Notifications under a particular Communication Profile](https://knowledgecenter.zuora.com/DC_Developers/BB_C_Settings_API/Settings_API_tutorials/Get_all_Notifications_under_a_particular_Communication_Profile) - name: OAuth description: "Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora\ \ REST API. \n\nYou must first create an OAuth client in the Zuora UI before using\ \ the [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken)\ \ operation to create an OAuth token. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/)\ \ for more information.\n" - name: Offers description: | Use offers to define different product packages with multiple prices for all charge types across different geographic regions, sales areas, customers, or billing frequencies, for example. The Offer object is in the **Beta** phase. - name: Operations description: 'Use operations to generate invoices and credit memos, collect payments for posted invoices, and generate previews of future invoice items for customer accounts. ' - name: Orders description: "Orders are contractual agreements between merchants and customers.\ \ \n\nFor more information about Orders, see Orders.\n" - name: Order Actions description: 'You need to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization) feature enabled to use this API. ' - name: Order Line Items description: | Use order line item to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. For more information about order line items, see Order Line Items. - name: Payment Gateways description: "Use payment gateways to pass authorization, payments, and settlement\ \ data securely to and from the merchant's website to the merchant's processor.\ \ \n\nFor more information about payment gateways, see Payment Gateways.\n" - name: Payment Gateway Reconciliation description: "Gateway reconciliation is the process of verifying that the electronic\ \ payment and refund transactions processed in Zuora match the transactions reported\ \ by the gateway. \nFor example, if Zuora processed 200 transactions through a\ \ gateway, you should see the same number of transactions on the gateway's reconciliation\ \ report, sometimes also called the settlement report.\n\nYou can complete the\ \ following Gateway Reconciliation tasks through API:\n- [Settle a payment](https://developer.zuora.com/api-references/api/operation/POST_SettlePayment/)\n\ - [Reject a payment](https://developer.zuora.com/api-references/api/operation/POST_RejectPayment/)\n\ - [Reverse a payment](https://developer.zuora.com/api-references/api/operation/POST_ReversePayment/)\n\ - [Reconcile a refund](https://developer.zuora.com/api-references/api/operation/POST_ReconcileRefund/)\n" - name: Payment Method Snapshots description: "A Payment Method Snapshot is a copy of the particular Payment Method\ \ used in a transaction. If the Payment Method is deleted, the Snapshot continues\ \ to retain the data used in each of the past transactions. \nAs such, the Snapshot\ \ helps with display of historical transactions, integrations to external systems,\ \ and reporting.\n" - name: Payment Method Transaction Logs description: | The PaymentMethodTransactionLog object contains payment method transaction log data. You can use the [CRUD: Retrieve a payment method transaction log](https://www.zuora.com/redocly-test/api-references/api/operation/Object_GETPaymentMethodTransactionLog/) operation to export such data. - name: Payment Methods description: 'Payment methods represents payment method details associated with a customer account. ' - name: Payment Method Updater description: 'Zuora Payment Method Updater (PMU) enables merchants to automatically incorporate changes made to a customer''s credit cards. For more information about Zuora PMU, see Payment Method Updater. ' - name: Payment Runs description: | Use payment runs to collect payments using electronic payment methods, for example, credit cards and ACH. For more information about payment runs, see Payment Runs. - name: Payment Schedules description: | Use payment schedules to split invoice or account balances into several installments and automatically process payments for the installments. For more information about payment schedules, see Payment Schedules. - name: Payment Transaction Logs description: 'Use payment transaction logs to export logs of all transactions from Zuora to the Gateway for Payments. ' - name: Payment Authorization description: "The Delayed Capture feature allows you to authorize the availability\ \ of funds for a transaction but delay the capture of funds until a later time.\n\ \nYou can use the [Create authorization](https://developer.zuora.com/api-references/api/operation/POST_CreateAuthorization/)\ \ operation to authorize a payment amount before capturing the payment. \nSubsequently,\ \ you can use [Create a payment](https://developer.zuora.com/api-references/api/operation/POST_CreatePayment)\ \ or [Create an order](https://developer.zuora.com/api-references/api/operation/POST_Order/)\ \ to capture the authorized funds, or use [Cancel authorization](https://developer.zuora.com/api-references/api/operation/POST_CancelAuthorization)\ \ to cancel the authorization.\n" - name: Payments description: | Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments. - name: Prepaid with Drawdown description: 'The Prepaid with Drawdown feature is a pricing model for consumption-based services, such as data storage. Under this model, customers pay upfront to receive a number of units, usually for a period of time like a month or a year. Then they consume against that prepayment balance in a use-it-or-lose-it fashion, with a possibility of topping up more units or being charged for any overage. This model strikes a balance between upfront commitment and the pure pay-as-you-go pricing models. For more information, see Prepaid with Drawdown. ' - name: Price Book Items description: "Use price book items to define as many price points as needed for\ \ an individual product rate plan charge without the need of duplicating the product\ \ rate plan and rate plan charges in your catalog.\n\nThe Price Book Item object\ \ is in the **Beta** phase. \n" - name: Product Charge Definitions description: "Use product charge definitions to define the attributes that can determine\ \ the charge behavior, such as billing attributes, pricing attributes, \ntaxation\ \ attributes, or accounting attributes.\n\nThe Product Charge Definition object\ \ is in the **Early Adopter** phase. We are actively soliciting feedback from\ \ a small set of early adopters before releasing it as generally available. If\ \ you are interested, please reach out to your CSM. \n" - name: Product Rate Plan Definitions description: "Use product rate plan definitions to reuse charges in different product\ \ rate plans.\n\nThe Product Rate Plan Definition object is in the **Early Adopter**\ \ phase. We are actively soliciting feedback from a small set of early adopters\ \ before releasing it as generally available. If you are interested, please reach\ \ out to your CSM. \n" - name: Product Rate Plan Charge Tiers description: 'To manage product rate plan charge tiers, use the [Product Rate Plan Charges](https://developer.zuora.com/api-references/api/tag/Product-Rate-Plan-Charges) operations instead to update the corresponding product rate plan charge with all the tiers. ' - name: Product Rate Plan Charges description: | A product rate plan charge represents a charge model or a set of fees associated with a product rate plan, which is the part of a product that your customers subscribe to. Each product rate plan can have multiple product rate plan charges. Product rate plan charges can be of three types: one-time fees, recurring fees, and usage fees. For example, the $50 activation fee for the Topaz product rate plan is a one-time product rate plan charge. - name: Product Rate Plans description: 'A product rate plan is the part of a product that your customers subscribe to. Each product can have multiple product rate plans, and each product rate plan can have multiple product rate plan charges, which are fees for products and their product rate plans. ' - name: Products description: | A product is an item or service that your company sells. In the subscription economy, a product is generally a service that your customers subscribe to rather than a physical item that they purchase one time. For example, customers subscribe to a service that provides them a car when and where they need a car rather than buying a car outright. A Product object contains all of the items in a specific product, especially product rate plans and product rate plan charges. Each Product object can have multiple rate plans, which in turn can each have multiple rate plan charges. Each rate plan charge can have multiple tiers. Taken together, all of these items create a single product. Customers subscribe to products that are in your product catalog. Product objects collectively compose your product catalog. You create your product catalog by creating products. As soon as you create your first product, you create your product catalog. - name: Ramps description: | A Ramp is a time container to associate with rate plan charges in your subscription. Inside the Ramp, you can further define a set of Ramp Intervals (time-based periods) where products or pricing can change. These periods are sub time containers to enable you to report out-of-the-box metrics based on Ramp Intervals. **Notes**: You must have both the Ramps feature and Orders feature enabled for your tenant to use the Ramps operations. For more information, see Ramps and Ramp Metrics. - name: Rate Plans description: "A rate plan is part of a subscription or an amendment to a subscription,\ \ and it comes from a product rate plan. Like a product and its product rate plans,\ \ a subscription can have one or more rate plans. \nRate plans are sometimes called\ \ subscription rate plans. Rate plans that are part of an amendment are sometimes\ \ called amendment rate plans.\n\nRate plans represent a price or a collection\ \ of prices for a service you sell. An individual rate plan contains all charges\ \ specific to a particular subscription.\n" - name: Refunds description: "Zuora allows you to issue and track refunds on payments. Similar to\ \ external payments, users can enter external refunds to track refunds that have\ \ been performed outside of Zuora Payments (for example, by issuing a check).\ \ \nIn addition, you can make electronic refunds using our supported payment gateways,\ \ which will automatically refund money to the customer.\n" - name: Regenerate description: "If you are an Order to Revenue user, you can use the Regenerate operations\ \ to regenerate transactions objects. \n" - name: RSA Signatures description: "The REST API used in Payment Pages 2.0 are CORS (Cross-Origin Resource\ \ Sharing) enabled and therefore requires a digital signature. \n\nYou can use\ \ the [Generate an RSA signature](https://www.zuora.com/redocly-test/api-references/api/operation/POST_RSASignatures/)\ \ operation to generate the required digital signature and token for a Payment\ \ Pages 2.0 form, then use the [Decrypt an RSA signature](https://www.zuora.com/redocly-test/api-references/api/operation/POST_DecryptRSASignatures/)\ \ operation to decrypt the signature to validate the signature and key.\" \n" - name: Sequence Sets description: "You can create billing document sequence sets through the REST API\ \ or the Zuora UI, allowing distinct numbering sequences for billing documents,\ \ payments, and refunds. \n\nTo create a billing document sequence set through\ \ the Zuora UI, see Create Billing Document Sequence Sets for more information.\n" - name: Settings description: | The Setting API provides a central API for managing settings in your Zuora tenant. If you use Postman, you can import the Settings API endpoints as a collection into your Postman app and try out different requests to learn how the API works. Click the following button to get started: [![Run in Postman](https://run.pstmn.io/button.svg)](https://www.getpostman.com/run-collection/1379901-d43e93a3-7d51-437c-b4cd-14163dd62fa2-SWLk4kiK) You can sign up for a free account on the [Postman website](https://identity.getpostman.com/signup) and download the app in case you do not use Postman yet. - name: Sign Up description: "A light-weight API to sign up customers and subscribe. \n\nYou need\ \ to have the [Orders](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders)\ \ or [Orders Harmonization](https://knowledgecenter.zuora.com/Zuora_Billing/Subscriptions/Orders/Orders_Harmonization)\ \ feature enabled to use this API.\n" - name: Subscriptions description: | A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as activation fees. Every subscription must be associated with an account. At least one active account must exist before any subscriptions can be created. For more information, see Subscriptions. - name: Summary Journal Entries description: "A summary journal entry is a summary of Zuora transaction amounts\ \ organized by accounting code and general ledger segments. A segment adds more\ \ reporting granularity through business dimensions, such as country or product.\ \ \n\nFor more information, see Summary Journal Entries Introduction\n" - name: Taxation Items description: | The TaxationItem object is used to add a tax amount to an invoice item. In the typical use case, the tax amount that you specify in the object is calculated by Z-Tax or a third-party tax engine such as Avalara or Connect tax engine. Changes that you make with this object affect the product charges in your product catalog, but not the charges in existing subscriptions. - name: Usage description: "Consumption of a billable service or resource (such as database storage\ \ space or bundles of emails sent) provides the basis for some charge models -\ \ simple usage, tiered pricing, or volume pricing. \nTo make this work, usage\ \ must be tracked in the system and usage charges must be calculated and invoiced.\ \ \nUsage is always billed in arrears - for example, you might bill customers\ \ in February for their January usage. Usage can be billed on a recurring monthly,\ \ quarterly, semi-annual, or annual basis.\n\nFor more information about working\ \ with usage data, see Usage.\n" - name: Workflows description: | A workflow is a sequence of tasks that are performed based on predefined logic. A workflow improves efficiency and reduces errors by automating a series of complex tasks that otherwise need to be performed manually and repetitively. For more information, see Workflow. - name: Zuora Revenue Integration description: '**Note:** You can only use the operations in this section if you have the Billing - Revenue Integration feature enabled. See Billing - Revenue Integration for more information. ' parameters: GLOBAL_HEADER_Authorization_OAuth: name: Authorization in: header required: true 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](https://developer.zuora.com/api-references/api/operation/createToken). ' 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](https://developer.zuora.com/api-references/api/operation/createToken). ' 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_Org_Ids: name: Zuora-Org-Ids in: header required: false type: string description: "Comma separated IDs. If you have Zuora Multi-Org 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_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_HEADER_If_Match: name: If-Match in: header required: false type: string description: "The expected ETag of the resource. You can use this header to perform\ \ a conditional request. Zuora responds with 412 Precondition Failed if the\ \ ETag of the resource does not match the value of this header. \n" 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. ' 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_REQUEST_pageSize_catalog: name: pageSize in: query required: false type: integer maximum: 40 default: 10 description: 'The number of records returned per page in the response. ' GLOBAL_REQUEST_pageSize_finance_accounting: name: pageSize in: query required: false type: integer maximum: 300 default: 300 description: 'The number of records returned per page in the response. ' GLOBAL_REQUEST_pageSize_finance_revenue: name: pageSize in: query required: false type: integer maximum: 300 default: 8 description: 'The number of records returned per page in the response. ' GLOBAL_HEADER_X_Zuora_WSDL_Version: name: X-Zuora-WSDL-Version in: header required: false type: string default: 79 description: 'Zuora WSDL version number. ' GLOBAL_REQUEST_rejectUnknownFields: name: rejectUnknownFields in: query required: false type: boolean default: false description: | Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a 400 response if the request body contains unknown fields. The body of the 400 response is: ```json { "message": "Error - unrecognised fields" } ``` By default, Zuora ignores unknown fields in the request body. GLOBAL_HEADER_Charge_Metrics_Accept: name: Accept in: header required: false type: string description: 'Expressed as MIME types that the client is able to understand. Using content negotiation, the server then selects one of the proposals, uses it and informs the client of its choice with the `Content-Type` response header. The possible response MIME types are `application/json-seq` compatible with http://jsonlines.org/, and `text/csv` compatible with RFC 4180. `application/json-seq` is the default response MIME type. If the `Accept` header is not sepecified, or set */*, the response body is returned in application/json-seq MIME type. ' 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\n\ With this header specified, the Zuora server can identify subsequent retries\ \ of the same request using this value, which prevents the same operation from\ \ being performed multiple times by accident. \n" 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_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. ' paths: /v1/accounting-codes: post: summary: Create an accounting code operationId: POST_AccountingCode description: "This reference describes how to create a new accounting code through\ \ the REST API. \nThe accounting code will be active as soon as it has been\ \ created.\n\n### Prerequisites\n If you have Zuora Finance enabled on your\ \ tenant, you must have the Configure Accounting Codes permission. \n" tags: - Accounting Codes parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTAccountingCodeType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a8081ae547aac1e01547efb61f20140 success: true description: '' schema: $ref: '#/definitions/POSTAccountingCodeResponseType' get: summary: List all accounting codes operationId: GET_AllAccountingCodes description: This reference describes how to query all accounting codes in your chart of accounts through the REST API. tags: - Accounting Codes 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_finance_accounting' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: accountingCodes: - id: e20b0747478025a10147816ba1c20097 name: Accounts Receivable type: AccountsReceivable glAccountName: null glAccountNumber: null notes: null category: Assets status: Active createdOn: '2014-07-29 02:20:20' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2014-07-29 02:20:20' updatedBy: e20b074746ec48f40147140f51e30a1a - id: e20b0747478025a10147816ba21900a0 name: Discounts type: SalesDiscounts glAccountName: null glAccountNumber: null notes: null category: Revenue status: Inactive createdOn: '2014-07-29 02:20:20' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2014-09-27 22:11:07' updatedBy: e20b074746ec48f40147140f51e30a1a success: true description: '' schema: $ref: '#/definitions/GETAccountingCodesType' /v1/accounting-codes/{ac-id}/activate: put: summary: Activate an accounting code operationId: PUT_ActivateAccountingCode description: "This reference describes how to activate an accounting code through\ \ the REST API.\n\nPrerequisites\n-------------\nIf you have Zuora Finance\ \ enabled on your tenant, you must have the Manage Accounting Code permission.\ \ \n" tags: - Accounting Codes 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: ac-id in: path required: true type: string description: ID of the accounting code you want to activate. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-codes/{ac-id}/deactivate: put: summary: Deactivate an accounting code operationId: PUT_DeactivateAccountingCode description: "This reference describes how to deactivate an accounting code\ \ through the REST API.\n\n### Prerequisites\nIf you have Zuora Finance enabled\ \ on your tenant, you must have the Manage Accounting Code permission.\n###\ \ Limitations\nYou can only deactivate accounting codes that are not associated\ \ with any transactions. \nYou cannot disable accounting codes of type AccountsReceivable.\n" tags: - Accounting Codes 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: ac-id in: path required: true type: string description: ID of the accounting code you want to deactivate. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-codes/{ac-id}: delete: summary: Delete an accounting code operationId: DELETE_AccountingCode description: | This reference describes how to delete an accounting code through the REST API. ### Prerequisites If you have Zuora Finance enabled on your tenant, then you must have the Delete Unused Accounting Code permission. ### Limitations You can only delete accounting codes that have never been associated with any transactions. An accounting code must be deactivated before you can delete it. tags: - Accounting Codes 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: ac-id in: path required: true type: string description: ID of the accounting code you want to delete. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' get: summary: Retrieve an accounting code operationId: GET_AccountingCode description: This reference describes how to query an accounting code through the REST API. tags: - Accounting Codes 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: ac-id in: path description: ID of the accounting code you want to query. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a8081ae547aac1e01547efb61f20140 name: CASH type: Cash glAccountName: null glAccountNumber: null notes: null category: Assets status: Active createdOn: '2016-05-04 01:23:07' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-05-05 20:07:38' updatedBy: e20b074746ec48f40147140f51e30a1a success: true description: '' schema: $ref: '#/definitions/GETAccountingCodeItemType' put: summary: Update an accounting code operationId: PUT_AccountingCode description: "This reference describes how to update an existing accounting\ \ code through the REST API.\n### Prerequisites\n If you have Zuora Finance\ \ enabled on your tenant, you must have the Manage Accounting Code permission.\ \ \n### Limitations\nYou can only update accounting codes that are not already\ \ associated with any transactions.\n" tags: - Accounting Codes 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: ac-id in: path description: ID of the accounting code you want to update. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTAccountingCodeType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-periods/{ap-id}/close: put: summary: Close an accounting period operationId: PUT_CloseAccountingPeriod description: |- Close an accounting period by accounting period ID. Prerequisites ------------- You must have Zuora Finance enabled on your tenant. You must have the Manage Close Process and Run Trial Balance user permissions. Limitations ----------- * The accounting period cannot already be closed. * The accounting period cannot be in the process of running a trial balance. * All earlier accounting periods must be closed. * There must be no required action items for the accounting period. See Reconcile Transactions Before Closing an Accounting Period for more information. Notes ----- When you close an accounting period in Zuora, a trial balance is automatically run for that period. A successful response means only that the accounting period is now closed, but does not mean that the trial balance has successfully completed. tags: - Accounting Periods 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: ap-id in: path description: ID of the accounting period you want to close. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-periods/{ap-id}/pending-close: put: summary: Set an accounting period to pending close operationId: PUT_PendingCloseAccountingPeriod description: "Sets an accounting period to pending close.\n\n\nPrerequisites\n\ -------------\n\n* You must have Zuora Finance enabled on your tenant.\n*\ \ You must have the Manage Close Process and Run Trial Balance user permissions.\n\ \n \nLimitations \n -----------\n \n * The accounting period cannot\ \ be closed or pending close.\n \n * The accounting period cannot be in the\ \ process of running a trial balance.\n \n * All earlier accounting periods\ \ must be closed.\n \n \nNotes\n-----\nWhen you set an accounting period to\ \ pending close in Zuora, a trial balance is automatically run for that period.\ \ A response of `{ \"success\": true }` means only that the accounting period\ \ status is now pending close, but does not mean that the trial balance has\ \ successfully completed. You can use the Get Accounting Period REST API call\ \ to view details about the outcome of the trial balance.\n" tags: - Accounting Periods 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: ap-id in: path description: ID of the accounting period you want to set to pending close. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-periods: post: summary: Create an accounting period operationId: POST_AccountingPeriod description: |- Creates an accounting period. Prerequisites ------------- * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user permission. Limitations ----------- * When creating the first accounting period on your tenant, the start date must be equal to or earlier than the date of the earliest transaction on the tenant. * Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1. * If you have the Revenue Recognition Package and have enabled the "Monthly recognition over time" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month. tags: - Accounting Periods parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTAccountingPeriodType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 7b7181ae547aac1e01547efb61f20162 success: true description: '' schema: $ref: '#/definitions/POSTAccountingPeriodResponseType' get: summary: List all accounting periods operationId: GET_AllAccountingPeriods description: Retrieves all accounting periods on your tenant. tags: - Accounting Periods 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_finance_accounting' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: accountingPeriods: - id: 8a8081ae5374904f01538338b66e1005 name: Mar 2016 startDate: '2016-03-01' endDate: '2016-03-31' status: Open runTrialBalanceStatus: Error runTrialBalanceStart: '2016-03-16 23:25:22' runTrialBalanceEnd: null runTrialBalanceErrorMessage: 'Error creating the trial balance: exchange rate from USD to GBP on 08/03/2015 is not available. Please import the rate and run trial balance again.' fiscalYear: 2016 notes: '' fileIds: unprocessedChargesFileId: null accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f01538340273013f3 accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f01538340274a13f4 revenueDetailExcelFileId: 8a8081ae5374904f0153834032e41417 revenueDetailCsvFileId: 8a8081ae5374904f0153834033221418 arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null createdOn: '2016-03-16 23:17:25' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-03-16 23:25:22' updatedBy: e20b074746ec48f40147140f51e30a1a - id: 8a8081ae5374904f0153833918af1007 name: Apr 2016 startDate: '2016-04-01' endDate: '2016-04-30' status: Open runTrialBalanceStatus: Error runTrialBalanceStart: '2016-03-16 23:23:40' runTrialBalanceEnd: null runTrialBalanceErrorMessage: null fiscalYear: 2016 notes: '' fileIds: unprocessedChargesFileId: null accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f0153833e9a651363 accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f0153833e9a7a1364 revenueDetailExcelFileId: 8a8081ae5374904f0153833ea2c813ae revenueDetailCsvFileId: 8a8081ae5374904f0153833ea2d613af arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null createdOn: '2016-03-16 23:17:50' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-03-16 23:23:40' updatedBy: e20b074746ec48f40147140f51e30a1a - id: 8a8081ae5374904f0153833e4590132d name: May 2016 startDate: '2016-05-01' endDate: '2016-05-31' status: Open runTrialBalanceStatus: Error runTrialBalanceStart: '2016-05-18 01:42:30' runTrialBalanceEnd: null runTrialBalanceErrorMessage: null fiscalYear: 2016 notes: '' fileIds: unprocessedChargesFileId: null accountsReceivableInvoiceAgingDetailExportFileId: null accountsReceivableAccountAgingDetailExportFileId: null revenueDetailExcelFileId: 8a8081ae54c2eabb0154c307e27e0033 revenueDetailCsvFileId: 8a8081ae54c2eabb0154c307e2920034 arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null createdOn: '2016-03-16 23:23:29' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-05-18 01:42:30' updatedBy: e20b074746ec48f40147140f51e30a1a - id: e20b0747478025a1014780e489a60002 name: Open-Ended startDate: '2016-06-01' endDate: null status: Open runTrialBalanceStatus: Pending runTrialBalanceStart: null runTrialBalanceEnd: null runTrialBalanceErrorMessage: null fiscalYear: 0 notes: null fileIds: unprocessedChargesFileId: null accountsReceivableInvoiceAgingDetailExportFileId: null accountsReceivableAccountAgingDetailExportFileId: null revenueDetailExcelFileId: null revenueDetailCsvFileId: null arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null createdOn: '2014-07-28 23:52:46' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2016-03-16 23:23:29' updatedBy: e20b074746ec48f40147140f51e30a1a success: true description: '' schema: $ref: '#/definitions/GETAccountingPeriodsType' /v1/accounting-periods/{ap-id}: get: summary: Retrieve an accounting period operationId: GET_AccountingPeriod description: | Retrieves an accounting period. Prerequisites ------------- You must have Zuora Finance enabled on your tenant. tags: - Accounting Periods 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: ap-id in: path description: ID of the accounting period you want to get. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: e20b074749d2a38b0149eac2e9550aa9 name: Oct 2014 startDate: '2014-10-01' endDate: '2014-10-31' status: Closed runTrialBalanceStatus: Completed runTrialBalanceStart: '2015-09-28 00:53:13' runTrialBalanceEnd: '2015-09-28 00:53:36' runTrialBalanceErrorMessage: null fiscalYear: 2014 notes: '' fileIds: unprocessedChargesFileId: null accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5002967c015012f122f10913 accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5002967c015012f1230e0914 revenueDetailExcelFileId: 8a8081ae5002967c015012f129870925 revenueDetailCsvFileId: 8a8081ae5002967c015012f129a10926 arRollForwardDetailExportFileId: 8a8081ae5002967c015012f15d7b09e2 fxRealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f151a609ba fxUnrealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f150b509b8 createdOn: '2014-11-25 22:21:22' createdBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2015-09-28 00:53:13' updatedBy: e20b074746ec48f40147140f51e30a1a success: true description: '' schema: $ref: '#/definitions/GETAccountingPeriodType' put: summary: Update an accounting period operationId: PUT_UpdateAccountingPeriod description: |2 Updates an accounting period. Prerequisites ------------- * You must have Zuora Finance enabled on your tenant. * You must have the Create Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). Limitations ----------- * You can update the start date of only the earliest accounting period on your tenant. You cannot update the start date of later periods. * If you update the earliest accounting period, the start date must be equal to or earlier than the date of the earliest transaction on the tenant. * Start and end dates of accounting periods must be contiguous. For example, if one accounting period ends on January 31, the next period must start on February 1. * If you have the Revenue Recognition Package and have enabled the "Monthly recognition over time" revenue recognition model, the accounting period start date and end date must be on the first day and last day of the month, respectively. Note that the start and end dates do not necessarily have to be in the same month. * You cannot update the start date or end date of an accounting period if: * Any revenue has been distributed into the period. * The period has any active journal entries. tags: - Accounting Periods 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: ap-id in: path description: ID of the accounting period you want to update. required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTAccountingPeriodType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' delete: summary: Delete an accounting period operationId: DELETE_AccountingPeriod description: | Deletes an accounting period. Prerequisites ------------- * You must have Zuora Finance enabled on your tenant. * You must have the Delete Accounting Period user permission. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). Limitations ----------- The accounting period to be deleted: * Must be the most recent accounting period * Must be an open accounting period * Must have no revenue distributed into it * Must not have any active journal entries * Must not be the open-ended accounting period * Must not be in the process of running a trial balance tags: - Accounting Periods 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: ap-id in: path required: true type: string description: ID of the accounting period you want to delete. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-periods/{ap-id}/reopen: put: summary: Reopen an accounting period operationId: PUT_ReopenAccountingPeriod description: |- Re-opens an accounting period. Prerequisites ------------- * You must have Zuora Finance enabled on your tenant. * You must have the Manage Close Process and Run Trial Balance user permissions. Limitations ----------- * The accounting period must be closed or pending close. * You can only re-open an accounting period that is immediately previous to an open period. tags: - Accounting Periods 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: ap-id in: path required: true type: string description: ID of the accounting period that you want to re-open. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounting-periods/{ap-id}/run-trial-balance: put: summary: Run trial balance operationId: PUT_RunTrialBalance description: "Runs the trial balance for an accounting period. \n\nPrerequisites\n\ -------------\n\n* You must have Zuora Finance enabled on your tenant.\n\n\ * You must have the Manage Close Process and Run Trial Balance user permissions.\ \ See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles).\n\ \n \nLimitations \n-----------\n \n * The accounting period must\ \ be open.\n \n * The accounting period cannot already be in the process of\ \ running a trial balance.\n \nNotes\n-----\nThe trial balance is run asynchronously.\ \ A response of `{ \"success\": true }` means only that the trial balance\ \ has started processing, but does not mean that the trial balance has successfully\ \ completed. You can use the [Get Accounting Period](https://developer.zuora.com/api-references/api/operation/GET_AccountingPeriod)\ \ REST API call to view details about the outcome of the trial balance.\n" tags: - Accounting Periods 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: ap-id in: path required: true type: string description: ID of the accounting period for which you want to run a trial balance. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/accounts: post: summary: Create an account operationId: POST_Account description: "Creates a customer account with a payment method, a bill-to contact,\ \ and an optional sold-to contact. Request and response field descriptions\ \ and sample code are provided. Use this operation to optionally create a\ \ subscription, invoice for that subscription, and collect payment through\ \ the default payment method. The transaction is atomic; if any part fails\ \ for any reason, the entire transaction is rolled back.\n\nThis operation\ \ is CORS Enabled, so you can use client-side Javascript to invoke the call.\ \ \n\n### Notes\n1. The account is created in active status. \n2. If the\ \ `autoPay` field is set to `true` in the request, you must provide one of\ \ the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field,\ \ but not multiple. The one provided becomes the default payment method for\ \ this account. If the credit card information is declined or cannot be verified,\ \ no account is created.\n3. Customer accounts created with this call are\ \ automatically be set to Auto Pay.\n4. If the `invoiceDeliveryPrefsEmail`\ \ field is not specified in the request, the account's email delivery preference\ \ is always automatically set to `false`, no matter whether the `workEmail`\ \ or `personalEmail` field is specified.\n\n### Defaults for customerAcceptanceDate\ \ and serviceActivationDate\nDefault values for **customerAcceptanceDate**\ \ and **serviceActivationDate** are set as follows.\n\n| | serviceActivationDate(SA)\ \ specified | serviceActivationDate (SA) NOT specified |\n| -------------\ \ |:-------------:| -----:|\n| customerAcceptanceDate (CA) specified \ \ | SA uses value in the request call; CA uses value in the request call|\ \ CA uses value in the request call;SA uses CE as default |\n| customerAcceptanceDate\ \ (CA) NOT specified | SA uses value in the request call; CA uses SA\ \ as default | SA and CA use CE as default |\n" tags: - Accounts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "The minor version of the Zuora REST API. \n\nYou only need to\ \ set this parameter if you use the following fields:\n* invoice\n* collect\n\ * runBilling\n* targetDate\n" - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTAccountType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true accountId: 402892c74c9193cd014c96bbe7c101f9 accountNumber: A00000004 billToContactId: 2c92c8fb68a28d180168a7ccedba1c4c soldToContactId: 2c92c8fb68a28d180168a7ccedc61c4e paymentMethodId: 402892c74c9193cd014c96bbe7d901fd description: '' schema: $ref: '#/definitions/POSTAccountResponseType' /v1/accounts/{account-key}: get: summary: Retrieve an account operationId: GET_Account description: | Retrieves basic information about a customer account. This operation is a quick retrieval that doesn't include the account's subscriptions, invoices, payments, or usage details. Use Get account summary to get more detailed information about an account. tags: - Accounts 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: account-key in: path description: Account number or account ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: basicInfo: id: 402892c74c9193cd014c91d35b0a0132 name: Test accountNumber: A00000001 notes: '' status: Active crmId: '' batch: Batch1 invoiceTemplateId: null communicationProfileId: 303d186840e611df817c002185d714e1 profileNumber: CP-00000012 salesRep: '' sequenceSetId: null partnerAccount: false billingAndPayment: autoPay: true billCycleDay: 1 currency: USD defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad paymentTerm: Net 30 paymentGateway: TestGateway invoiceDeliveryPrefsPrint: false invoiceDeliveryPrefsEmail: true additionalEmailAddresses: - contact1@example.com - contact2@example.com metrics: balance: 0 totalInvoiceBalance: 0 creditBalance: 0 contractedMrr: -900 metricsData: - currency: USD balance: 0 totalInvoiceBalance: 0 totalDebitMemoBalance: 0 unappliedPaymentAmount: 0 unappliedCreditMemoAmount: 0 contractedMrr: -900 reservedPaymentAmount: 900 - currency: EUR balance: 0 totalInvoiceBalance: 0 totalDebitMemoBalance: 0 unappliedPaymentAmount: 0 unappliedCreditMemoAmount: 0 contractedMrr: -900 reservedPaymentAmount: -900 billToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' soldToContact: address1: '' address2: '' city: '' country: null county: null fax: '' firstName: Test homePhone: '' id: 2c9081a03c6d7b51013c6d7e46cf0a18 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' einvoiceProfile: enabled: 'true' businessName: legal business name businessNumber: '20002039' businessNumberSchemeId: 088 taxRegisterNumber: TAX393999 endpointId: 08992 endpointSchemeId: 088 success: true description: '' schema: $ref: '#/definitions/GETAccountType' put: summary: Update an account operationId: PUT_Account description: | Updates a customer account by specifying the account-key. ### Notes 1. Only the fields to be changed should be specified. Any field that is not included in the request body will not be changed. 2. If an empty field is submitted with this operation, the corresponding field in the account is emptied. 3. Email addresses: If no email addresses are specified, no change is made to the email addresses or to the email delivery preference. If either the **personalEmail** or **workEmail** of **billToContact** is specified (or both), the system updates the corresponding email address(es) and the email delivery preference is set to `true`. (In that case, emails go to the **workEmail** address, if it exists, or else the **personalEmail**.) On the other hand, if as a result of this call both of the email addresses for the account are empty, the email delivery preference is set to `false`. 4. The bill-to and sold-to contacts are separate data entities. If you select the **Same as Bill To Contact** check box during account creation, both the Bill To and Sold To contacts are updated upon updating either one because they point to the same contact record. In this case, if you want to update only one of them, you have to first create another contact and update the Bill To or Sold To contact of the customer account to be the newly created one. tags: - Accounts 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: account-key in: path required: true type: string description: Account number or account ID. - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTAccountType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' delete: summary: Delete an account operationId: DELETE_Account description: "Deletes a specific account asynchronously. \n\n**Notes and Limitations:**\ \ \n- For account deletion, the system will start a backend job to remove\ \ all transactions under the accounts and change the status of the accounts\ \ to 'Cancelled'. This backend job is asynchronous and will take some time,\ \ depending on the job size. \n- An account cannot be deleted when the account\ \ is either the invoice owner or the subscription owner of a subscription\ \ and the subscription's invoice owner and subscription owner are two different\ \ accounts. An exception to this limitation is if the Enable Force Deletion for Account? setting is set\ \ to `Yes`, you can force delete an account that is the subscription owner\ \ of a subscription while the invoice owner is a different account. Force\ \ deleting this account deletes all its subscriptions, but the relevant invoices\ \ will not be impacted.\n- An account cannot be deleted if this account has\ \ ever been involved in an Owner Transfer amendment or order action, either\ \ as the current owner or as the previous owner. \n" tags: - Accounts 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: account-key in: path description: Account number or account ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Pending success: true description: '' schema: $ref: '#/definitions/DeleteAccountResponseType' /v1/accounts/{account-key}/summary: get: summary: Retrieve an account summary operationId: GET_AccountSummary description: "Retrieves detailed information about the specified customer account.\n\ \nThe response includes the account information and a summary of the account\u2019\ s subscriptions, invoices, payments, and usages.\n\n### Notes\nReturns only\ \ the six most recent subscriptions based on the subscription updatedDate.\ \ Within those subscriptions, there may be many rate plans and many rate plan\ \ charges. These items are subject to the maximum limit on the array size.\ \ \n" tags: - Accounts 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: account-key in: path required: true type: string description: Account number or account ID. - name: excludeUsage in: query required: false type: boolean description: Indicate whether to exclude usage information in the response. The default value is `false`. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: payments: - paidInvoices: - invoiceNumber: INV00000159 appliedPaymentAmount: 5.0 invoiceId: 2c92a09539190dbe0139190f42780012 - invoiceNumber: INV00000323 appliedPaymentAmount: 139722.1 invoiceId: 2c92a0953a3fa95d013a407c10a60100 - invoiceNumber: INV00000160 appliedPaymentAmount: 10521.0 invoiceId: 2c92a09739190dc60139194bcf1b0098 paymentNumber: P-00000075 status: Processed effectiveDate: '2013-03-27' id: 2c92c8f83dabf9cf013daf3bfa0305a6 paymentType: Electronic - paidInvoices: - invoiceNumber: INV00000159 appliedPaymentAmount: 5.0 invoiceId: 2c92a09539190dbe0139190f42780012 paymentNumber: P-00000056 status: Processed effectiveDate: '2012-08-11' id: 2c92a0f9391832b101391922ad5f049d paymentType: Electronic invoices: - amount: 139722.1 status: Posted invoiceNumber: INV00000323 invoiceDate: '2013-02-11' balance: 0.0 id: 2c92a0953a3fa95d013a407c10a60100 dueDate: '2013-02-11' - amount: 10521.0 status: Posted invoiceNumber: INV00000160 invoiceDate: '2012-08-11' balance: 0.0 id: 2c92a09739190dc60139194bcf1b0098 dueDate: '2012-08-11' - amount: 10.0 status: Posted invoiceNumber: INV00000159 invoiceDate: '2012-08-11' balance: 0.0 id: 2c92a09539190dbe0139190f42780012 dueDate: '2012-08-11' usage: - unitOfMeasure: UOM quantity: 10.0 startDate: 2012-02 - unitOfMeasure: UOM quantity: 10.0 startDate: 2012-01 basicInfo: defaultPaymentMethod: creditCardNumber: '************1111' paymentMethodType: CreditCard creditCardExpirationMonth: 10 creditCardExpirationYear: 2020 creditCardType: Visa id: 2c92c8f83dabf9cf013daef12dd303b0 autoPay: true status: Active lastInvoiceDate: '2013-02-11' lastPaymentAmount: 150248.1 billCycleDay: 1 invoiceDeliveryPrefsPrint: false invoiceDeliveryPrefsEmail: true additionalEmailAddresses: - contact1@example.com - contact2@example.com name: subscribeCallYan_1 balance: 0.0 accountNumber: A00001115 id: 2c92a0f9391832b10139183e277a0042 currency: USD lastPaymentDate: '2013-03-27' partnerAccount: false soldToContact: fax: '' taxRegion: '' country: United States zipCode: '95135' county: '' lastName: Cho workEmail: contact@example.com state: California address2: '' address1: 278 Bridgeton Circle firstName: Bill id: 2c92a0f9391832b10139183e27940043 workPhone: '5555551212' city: San Jose success: true subscriptions: - termEndDate: '2014-02-01' termStartDate: '2013-02-01' status: Active initialTerm: 12 autoRenew: true subscriptionNumber: A-S00001081 subscriptionStartDate: '2013-02-01' id: 2c92c8f83dc4f752013dc72c24ee016d ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier termType: TERMED renewalTerm: 3 - termEndDate: '2014-02-01' termStartDate: '2013-02-01' status: Active initialTerm: 12 autoRenew: true subscriptionNumber: A-S00001080 subscriptionStartDate: '2013-02-01' id: 2c92c8f83dc4f752013dc72bb85c0127 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier termType: TERMED renewalTerm: 3 - termEndDate: '2014-04-01' termStartDate: '2013-12-01' status: Cancelled initialTerm: 10 autoRenew: false subscriptionNumber: A-S00001079 subscriptionStartDate: '2013-02-01' id: 2c92c8f83dc4f752013dc723fdab00d4 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier termType: TERMED renewalTerm: 4 - termEndDate: '2012-02-11' termStartDate: '2011-02-11' status: Active initialTerm: 12 autoRenew: false subscriptionNumber: A-S00001076 subscriptionStartDate: '2011-02-11' id: 2c92c8f83db0b4b4013db4717ad000ec ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit termType: TERMED renewalTerm: 3 - termEndDate: '2012-02-11' termStartDate: '2011-02-11' status: Active initialTerm: 12 autoRenew: false subscriptionNumber: A-S00001075 subscriptionStartDate: '2011-02-11' id: 2c92c8f83db0b4b4013db3ab6a4d00bc ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit termType: TERMED renewalTerm: 3 - termEndDate: '2012-02-11' termStartDate: '2011-02-11' status: Active initialTerm: 12 autoRenew: false subscriptionNumber: A-S00001074 subscriptionStartDate: '2011-02-11' id: 2c92c8f83db0b4b4013db3aa9fbd0090 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit termType: TERMED renewalTerm: 3 billToContact: fax: '' taxRegion: '' country: United States zipCode: '95135' county: '' lastName: Zou workEmail: contact@example.com state: California address2: '' address1: 1400 Bridge Pkwy firstName: Cheng id: 2c92a0f9391832b10139183e27940043 workPhone: '5555551212' city: San Jose description: '' schema: $ref: '#/definitions/GETAccountSummaryType' /v1/accounts/{account-key}/payment-methods: get: summary: List payment methods of an account operationId: GET_AcountPaymentMethods description: | Retrieves the payment methods of the specified customer account. **Note:** This operation also supports retrieving custom payment methods created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service. tags: - Accounts 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: account-key in: path description: Account number or account ID. required: true type: string - name: isDefaultOnly in: query required: false type: boolean description: Indicates whether to only retrieve the default payment method of the account. The default value is `false`. If this parameter is set to `true`, only the default payment method is retrieved. - name: isActiveOnly in: query required: false type: boolean description: Indicates whether to only retrieve the active payment methods of the account. The default value is `false`. If this parameter is set to `true`, only the active payment methods are retrieved. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001 paymentGateway: null creditcard: - cardNumber: '************1111' expirationMonth: 11 expirationYear: 2027 creditCardType: Visa accountHolderInfo: accountHolderName: John Smith phone: '86123456789' email: example@google.com addressLine1: ABC addressLine2: EFT zipCode: '123456' city: Example City country: United States state: Example State mandateInfo: mitProfileAction: null mitProfileType: null mitConsentAgreementSrc: null mitConsentAgreementRef: null mitTransactionId: null mitProfileAgreedOn: null id: 4028839f7d26a155017d26af16ef0001 type: CreditCard isDefault: true accountKey: 4028839f7ca29000017ca29c1ce8003f status: Active lastTransaction: Approved useDefaultRetryRule: true bankIdentificationNumber: '411111' deviceSessionId: null existingMandate: null ipAddress: null lastFailedSaleTransactionDate: null lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null totalNumberOfProcessedPayments: 0 totalNumberOfErrorPayments: 0 createdDate: '2021-11-15 18:59:08' updatedDate: '2021-11-15 18:59:08' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 AA_PICKLIST__c: null debitcard: - cardNumber: '************8888' expirationMonth: 11 expirationYear: 2021 creditCardType: Electron accountHolderInfo: accountHolderName: John Smith phone: '' email: smith@example.com addressLine1: 1051 E Hillsdale Blvd addressLine2: '' zipCode: '45101' city: Tynan country: United States state: California mandateInfo: mitProfileAction: null mitProfileType: null mitConsentAgreementSrc: null mitConsentAgreementRef: null mitTransactionId: null mitProfileAgreedOn: null id: 4028839f7cd92a6b017cda4defd00006 type: CreditCard isDefault: false accountKey: 4028839f7ca29000017ca29c1ce8003f status: Active lastTransaction: Approved useDefaultRetryRule: true bankIdentificationNumber: '588888' deviceSessionId: null existingMandate: null ipAddress: null lastFailedSaleTransactionDate: null lastTransactionDateTime: '2021-11-01 00:01:53' lastTransactionStatus: Approved maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null totalNumberOfProcessedPayments: 0 totalNumberOfErrorPayments: 0 createdDate: '2021-11-01 00:01:52' updatedDate: '2021-11-01 00:01:52' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 AA_PICKLIST__c: null creditcardreferencetransaction: - tokenId: ABCE secondTokenId: FGDSDF id: 4028839f7ce8c530017ce9725e2c0003 type: CreditCardReferenceTransaction isDefault: false accountKey: 4028839f7ca29000017ca29c1ce8003f status: Active lastTransaction: Approved useDefaultRetryRule: true bankIdentificationNumber: null deviceSessionId: null existingMandate: null ipAddress: null lastFailedSaleTransactionDate: null lastTransactionDateTime: '2021-11-03 22:35:59' lastTransactionStatus: Approved maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null totalNumberOfProcessedPayments: 0 totalNumberOfErrorPayments: 0 createdDate: '2021-11-03 22:35:59' updatedDate: '2021-11-03 22:35:59' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 AA_PICKLIST__c: null cardNumber: null expirationMonth: 11 expirationYear: 2021 creditCardType: Visa accountHolderInfo: accountHolderName: '' phone: null email: '' addressLine1: '' addressLine2: '' zipCode: '' city: '' country: null state: '' mandateInfo: mitProfileAction: null mitProfileType: null mitConsentAgreementSrc: null mitConsentAgreementRef: null mitTransactionId: null mitProfileAgreedOn: null ach: - bankABACode: '110000000' bankAccountNumber: '********6789' bankAccountType: Checking bankName: Chase bankAccountName: Test accountHolderInfo: accountHolderName: null phone: '2554444' email: test@test.com addressLine1: DSDFD addressLine2: '' zipCode: '123456' city: Example City country: United States state: Example State mandateInfo: mandateId: null mandateReceivedStatus: null existingMandateStatus: null mandateCreationDate: null mandateUpdateDate: null mandateStatus: null mandateReason: null id: 4028839f7cc14262017cc1bca9eb0008 type: ACH isDefault: false accountKey: 4028839f7ca29000017ca29c1ce8003f status: Active lastTransaction: Approved useDefaultRetryRule: true bankIdentificationNumber: null deviceSessionId: null existingMandate: null ipAddress: null lastFailedSaleTransactionDate: null lastTransactionDateTime: '2021-10-27 05:32:19' lastTransactionStatus: Approved maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null totalNumberOfProcessedPayments: 0 totalNumberOfErrorPayments: 0 createdDate: '2021-10-27 05:32:19' updatedDate: '2021-11-10 00:50:12' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 AA_PICKLIST__c: null success: true description: '' schema: $ref: '#/definitions/GETAccountPaymentMethodType' /v1/accounts/{account-key}/payment-methods/default: get: summary: Retrieve the default payment method of an account operationId: GET_AcountDefaultPaymentMethod description: | Retrieves the default payment method of the specified customer account. **Note:** This operation also supports retrieving the custom payment method created through the [Open Payment Method](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/MB_Set_up_custom_payment_gateways_and_payment_methods) service. tags: - Accounts 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: account-key in: path description: Account number or account ID. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: cardNumber: '************1111' expirationMonth: 11 expirationYear: 2027 creditCardType: Visa accountHolderInfo: accountHolderName: John Smith phone: '86123456789' email: example@google.com addressLine1: ABC addressLine2: EFT zipCode: '844000' city: Example City country: United States state: Example State mandateInfo: mitProfileAction: null mitProfileType: null mitConsentAgreementSrc: null mitConsentAgreementRef: null mitTransactionId: null mitProfileAgreedOn: null id: 4028839f7d26a155017d26af16ef0001 type: CreditCard isDefault: true accountKey: 4028839f7ca29000017ca29c1ce8003f status: Active lastTransaction: Approved useDefaultRetryRule: true bankIdentificationNumber: '411111' deviceSessionId: null existingMandate: null ipAddress: null lastFailedSaleTransactionDate: null lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null totalNumberOfProcessedPayments: 0 totalNumberOfErrorPayments: 0 createdDate: '2021-11-15 18:59:08' updatedDate: '2021-11-15 18:59:08' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedBy: 402881e522cf4f9b0122cf5d82860002 AA_PICKLIST__c: null success: true description: '' schema: $ref: '#/definitions/GETPaymentMethodResponseForAccount' /v1/action/create: post: summary: Create operationId: Action_POSTcreate description: "Use the create call to create one or more objects of a specific\ \ type. You can specify different types in different create calls, but each\ \ create call must apply to only one type of object.\n\n### Limitations \n\ \nThis call has the following limitations:\n\n* A maximum of 50 objects are\ \ supported in a single call.\n* The Orders feature is not supported.\n* The\ \ Invoice Settlement feature is not supported. This feature includes Unapplied\ \ Payments, Credit and Debit Memo, and Invoice Item Settlement.\n* The default\ \ WSDL version for Actions is 79. To create objects according to a different\ \ WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which\ \ WSDL version a particular object or field was introduced, see [Zuora SOAP\ \ API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).\n\ \n\n### How to use this call\n\nYou can create on an array of one or more\ \ zObjects. The fields you should specify can be found in the corresponding\ \ \"CRUD: Create an *zObject*\" operation.\nFor example, to create one or\ \ multiple accounts, use the request fields in the [CRUD: Create an account](https://developer.zuora.com/api-references/older-api/operation/Object_POSTAccount/)\ \ operation.\n\nIt returns an array of SaveResults sorted in the same order,\ \ indicating the success or failure of creating each object. The following\ \ information applies to this call:\n\n* You cannot pass in null zObjects.\n\ * You can pass in a maximum of 50 zObjects at a time.\n* All objects must\ \ be of the same type.\n\n#### Using Create and Subscribe Calls \n\nBoth the\ \ Create and Subscribe calls will create a new account. However, there are\ \ differences between the calls.\n\nUse the create call to create an account\ \ independent of a subscription.\n\nUse the subscribe call to create the account\ \ with the subscription and the initial payment information.\n" tags: - Actions 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_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: createRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActioncreateRequest' responses: '200': examples: application/json: - Success: true Id: 2c93808457d787030157e0324aea5158 description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: description: '' type: array items: $ref: '#/definitions/SaveResult' '401': examples: application/json: message: Authentication error description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/delete: post: summary: Delete operationId: Action_POSTdelete description: | Deletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object. The following information applies to this call: * You will need to first determine the IDs for the objects you wish to delete. * You cannot pass in any null IDs. * All objects in a specific delete call must be of the same type. ### Objects per Call 50 objects are supported in a single call. tags: - Actions 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_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: deleteRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActiondeleteRequest' responses: '200': examples: application/json: - id: 2c93808457d787030157e031fcd34e19 success: true description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: type: array description: '' items: $ref: '#/definitions/DeleteResult' '401': examples: application/json: message: Authentication error description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/query: post: summary: Query operationId: Action_POSTquery description: "The query call sends a query expression by specifying the object\ \ to query, the fields to retrieve from that object, and any filters to determine\ \ whether a given object should be queried.\n\n\nYou can use [Zuora Object\ \ Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language)\ \ (ZOQL) to construct those queries, passing them through the `queryString`.\n\ \n\nOnce the call is made, the API executes the query against the specified\ \ object and returns a query response object to your application. Your application\ \ can then iterate through rows in the query response to retrieve information.\n\ \n### Limitations \n\nThis call has the following limitations:\n\n* All [ZOQL\ \ limitations](https://knowledgecenter.zuora.com/Central_Platform/Query/ZOQL#ZOQL_Limitations)\ \ apply.\n* All ZOQL keywords must be in lower case.\n* The number of records\ \ returned is limited to 2000 records.\n* The Invoice Settlement feature is\ \ not supported. This feature includes Unapplied Payments, Credit and Debit\ \ Memo, and Invoice Item Settlement.\n* The Orders feature is not supported,\ \ which means that the objects listed in [Orders Object Model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/BA_Orders_Object_Model)\ \ are not supported.\n* The Active Rating feature is not supported.\n* The\ \ default WSDL version for Actions is 79. To query objects or fields according\ \ to a different WSDL version, set the `X-Zuora-WSDL-Version` header. To find\ \ out in which WSDL version a particular object or field was introduced, see\ \ [Zuora SOAP API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).\n\ * Fields with NULL values are not returned in the response.\n" tags: - Actions 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_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: queryRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionqueryRequest' responses: '200': examples: application/json: records: - AdjustmentNumber: IIA-00000001 ServiceEndDate: '2016-10-20' Id: 2c93808457d787030157e0324aea5158 AccountingCode: Accounts Receivable UpdatedDate: '2016-10-20T05:46:14.000+02:00' AccountId: 2c93808457d787030157e032485b5131 Comment: this is comments InvoiceNumber: INV00000001 InvoiceId: 2c93808457d787030157e03248c75142 ServiceStartDate: '2016-10-20' CreatedById: 2c93808457d787030157e032283c4fb2 CreatedDate: '2016-10-20T05:46:14.000+02:00' InvoiceItemName: OneTime_Flat Fee Pricing1476935174089 UpdatedById: 2c93808457d787030157e032283c4fb2 Amount: 1.2 AdjustmentDate: '2016-10-20' SourceId: 2c93808457d787030157e03248c95144 SourceType: InvoiceDetail Status: Processed Type: Credit ReferenceId: refid-1476935174845 ReasonCode: Standard Adjustment size: 1 done: true description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ProxyActionqueryResponse' '401': examples: application/json: message: Authentication error description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/queryMore: post: summary: QueryMore operationId: Action_POSTqueryMore description: | Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results. Any `queryLocator` results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted. This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request the next set of results. **Note:** Zuora expires queryMore cursors after 15 minutes of activity. To use queryMore, you first construct a query call. By default, the query call will return up to 2000 results. If there are more than 2000 results, query will return a boolean `done`, which will be marked as `false`, and a `queryLocator`, which is a marker you will pass to queryMore to get the next set of results. tags: - Actions 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_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: queryMoreRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionqueryMoreRequest' responses: '200': description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ProxyActionqueryMoreResponse' '401': examples: application/json: message: Authentication error description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/action/update: post: summary: Update operationId: Action_POSTupdate description: "\nUpdates the information in one or more objects of the same type.\ \ You can specify different types of objects in different update calls, but\ \ each specific update call must apply to only one type of object.\n\n\n###\ \ Limitations \n\nThis call has the following limitations:\n\n* A maximum\ \ of 50 objects are supported in a single call.\n* The Invoice Settlement\ \ feature is not supported. This feature includes Unapplied Payments, Credit\ \ and Debit Memo, and Invoice Item Settlement.\n* The default WSDL version\ \ for Actions is 79. To update objects or fields according to a different\ \ WSDL version, set the `X-Zuora-WSDL-Version` header. To find out in which\ \ WSDL version a particular object or field was introduced, see [Zuora SOAP\ \ API Version History](https://knowledgecenter.zuora.com/DC_Developers/G_SOAP_API/Zuora_SOAP_API_Version_History).\n\ \n\n### How to use this call? \n\nYou can update an array of one or more zObjects.\ \ The fields you should specify can be found in the corresponding \"CRUD:\ \ Update an *zObject*\" operation.\nFor example, to update one or multiple\ \ accounts, use the request fields in the [CRUD: Update an account](https://developer.zuora.com/api-references/older-api/operation/Object_PUTAccount/)\ \ operation.\n\nIt returns an array of SaveResults sorted in the same order,\ \ indicating the success or failure of updating each object. The following\ \ information applies to this call:\n\n* You cannot pass in null zObjects.\n\ * You can pass in a maximum of 50 zObjects at a time.\n* All objects must\ \ be of the same type.\n* For each field in each object, you must determine\ \ that object's ID. Then populate the fields that you want update with the\ \ new information.\n* Zuora ignores unrecognized fields in update calls. For\ \ example, if an optional field is spelled incorrectly or a field that does\ \ not exist is specified, Zuora ignores the field and continues to process\ \ the call. No error message is returned for unrecognized fields.\n" tags: - Actions 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_REQUEST_rejectUnknownFields' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - name: updateRequest in: body description: '' required: true schema: $ref: '#/definitions/ProxyActionupdateRequest' responses: '200': examples: application/json: - Success: true Id: 2c93808457d787030157e0321fdf4fab description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: description: '' type: array items: $ref: '#/definitions/SaveResult' '401': examples: application/json: message: Authentication error description: '' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' WWW-Authenticate: type: string enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: $ref: '#/definitions/ProxyUnauthorizedResponse' /v1/batch-query/: post: operationId: POST_BatchQueryJob summary: Submit an aggregate query job description: 'Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries. ' tags: - Aggregate Queries 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: body in: body required: true description: '' schema: $ref: '#/definitions/SubmitBatchQueryRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/SubmitBatchQueryResponse' examples: application/json: sourceData: LIVE encrypted: none partner: salesforce useLastCompletedJobQueries: false project: 00170000011k3ub batches: - localizedStatus: pending apiVersion: '91.0' full: false recordCount: 0 batchId: 2c92c0f966cd4f580166ec0ac8a75bb8 batchType: zoqlexport status: pending name: AccountingPeriod query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod status: submitted name: Example id: 2c92c0f966cd4f580166ec0ac89d5bb7 version: '1.1' format: CSV /v1/batch-query/jobs/{jobid}: get: operationId: GET_BatchQueryJob summary: Retrieve an aggregate query job description: | Retrieves an aggregate query using the Job ID. Note that the completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder. tags: - Aggregate Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: jobid in: path required: true type: string description: 'Internal identifier of the query job. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetAggregateQueryJobResponse' examples: application/json: batches: - full: true name: AccountingPeriod message: '' query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod status: completed recordCount: 1 apiVersion: '60.0' fileId: 402881824835bb2a01483c19f8190259 batchType: zoqlexport batchId: 402881824835bb2a01483c19f7da0257 project: 00170000011K3Ub partner: salesforce name: Example id: 402881824835bb2a01483c19f7d70256 version: '1.1' format: CSV sourceData: LIVE startTime: '2014-09-03 08:20:07' status: completed encrypted: none delete: operationId: DELETE_BatchQueryJob summary: Cancel a running aggregate query job description: 'Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown. ' tags: - Aggregate Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: jobid in: path required: true type: string description: 'Internal identifier of the query job. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DeleteBatchQueryJobResponse' examples: application/json: name: June10 id: e20b07474688ad5001468daf10e501de version: '1.1' format: CSV sourceData: LIVE status: cancelled batches: - name: InvoiceItemAdjustment message: '' query: select AccountingCode,CancelledDate,CreatedDate,Id,InvoiceId,InvoiceItemName, InvoiceNumber,SourceType,AdjustmentNumber,ServiceStartDate,ServiceEndDate,AdjustmentDate, Amount,Status,AccountId,SourceId,Type,ReasonCode, UpdatedDate from InvoiceItemAdjustment status: completed recordCount: 1580 fileId: e20b07474688ad5001468daf155f01f5 batchId: e20b07474688ad5001468daf10ea01df batchType: zoqlexport - name: InvoiceAdjustment message: '' query: select AccountingCode,CancelledOn,CreatedDate,Id,ImpactAmount,Invoice.Id, InvoiceNumber,AdjustmentNumber,AdjustmentDate,Amount,Status,Account.Id,Type,ReasonCode, UpdatedDate from InvoiceAdjustment status: completed recordCount: 411 fileId: e20b07474688ad5001468daf166601f6 batchId: e20b07474688ad5001468daf10ec01e0 batchType: zoqlexport encrypted: none /v1/batch-query/jobs/partner/{partner}/project/{project}: get: operationId: GET_LastBatchQueryJob summary: Retrieve the last completed aggregate query job description: | Returns the details of the last completed job. The completed AQuA jobs that were created 180 days ago are deleted permanently from Zuora, so you cannot query these jobs through API or AQuA job finder. tags: - Aggregate Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: partner in: path required: true type: string description: "The unique ID of a data integration partner. \n" - name: project in: path required: true type: string description: 'The unique ID of a data integration project for a particular partner. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetAggregateQueryJobResponse' examples: application/json: batches: - full: false name: AccountingPeriod message: '' query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod status: completed recordCount: 0 apiVersion: '60.0' fileId: 402881824835bb2a01483c1e67c7025d batchType: zoqlexport batchId: 402881824835bb2a01483c1e678c025b project: 00170000011K3Ub partner: salesforce name: Example id: 402881824835bb2a01483c1e678a025a version: '1.1' format: CSV sourceData: LIVE startTime: '2014-09-03 08:24:58' status: completed encrypted: none /system-health/api-requests/volume-summary: get: operationId: GET_SystemHealthApiVolumeSummary summary: List API volume summary records description: | Returns volume summary of [API](https://knowledgecenter.zuora.com/Central_Platform/API) usage that generated by your Zuora tenant within a specified time range. You can filter the summary by API path name and http method. tags: - API Health parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: path in: query required: false type: string description: | Filters the volume summary by API path name. You can refer to the api listed in the [API System Health Dashboard](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Zuora_System_Health/B_APIs_dashboard) for the path name. Example: `/v1/accounts/{account-key}`. - name: httpMethod in: query required: false type: string description: 'Filters the volume summary by http method. Example: `POST`. ' - name: startTime in: query required: true type: string format: date-time description: | Start time of the volume summary. Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`. - name: endTime in: query required: true type: string format: date-time description: | End time of the volume summary. Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-29T09:07+0800`. responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetApiVolumeSummaryResponse' examples: application/json: data: - path: /notifications/notification-definitions httpMethod: DELETE success: 10 error: 0 total: 10 - path: /query/jobs/{job-id} httpMethod: GET success: 10 error: 20 total: 30 - '...' '400': description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/SystemHealthErrorResponse' examples: application/json: timestamp: '2022-09-29T05:54:46.007+00:00' status: 400 error: Bad Request message: Timezone is different between 'startTime' and 'endTime'. path: /system-health/api-requests/volume-summary x-code-samples: - lang: curl label: Curl source: "curl -i -X GET \\\n 'https://rest.zuora.com/system-health/api-requests/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-25T09:07-0800'\ \ \\ \n -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'\n" /v1/attachments: post: summary: Create an attachment operationId: POST_Attachments description: "Use the Add Attachment REST request with a multipart/form-data\ \ to attach a document file to an Account, a Subscription, an Invoice, a Credit\ \ Memo, or a Debit Memo.\n\nYou can only use this operation if you have a\ \ Billing role that includes the Manage Attachments permission.\nFor more\ \ information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\n\ To change your Billing role, contact your Zuora platform administrator.\n\n\ **Note**: The Credit and Debit Memos feature 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" consumes: - multipart/form-data tags: - Attachments 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: description in: query description: 'Description of the attachment document. ' required: false type: string - name: associatedObjectType in: query description: "The type of the object to add attachements for. \n" enum: - Account - Invoice - Subscription - CreditMemo - DebitMemo required: true type: string - name: associatedObjectKey in: query description: | For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every subscription version. For Account, Credit Memo, and Debit Memo, specify the corresponding ID or number. For Invoice, specify the corresponding ID. required: true type: string - name: file in: formData required: true type: file description: | The file to be attached. Files with the following extensions are supported: .pdf, .csv, .png, .xlsx, .xls, .doc, .docx, .msg, .jpg, .txt, .htm, .html, .eml, .pptx, .gif, .rtf, .xml, .jpeg, .log, .cls The maximum file size is 4 MB. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true id: 402880ea536ff494015372a7ea17001f fileId: 402880ea536ff494015372a7ea12001e description: '' schema: $ref: '#/definitions/POSTAttachmentResponseType' x-code-samples: - lang: curl label: Curl source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@PODocument.pdf" "https://rest.zuora.com/v1/attachments/?description=Postal%20order&associatedObjectType=Subscription&associatedObjectKey=A-S00005714" ' /v1/attachments/{object-type}/{object-key}: get: summary: List attachments by object type and key operationId: GET_AttachmentsList description: "Use the View Attachment REST request to get a list of attachments\ \ on an account, an invoice, a subscription, a credit memo, or a debit memo.\n\ \nYou can only use this operation if you have a Billing role that includes\ \ the Manage Attachments permission.\nFor more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles).\n\ To change your Billing role, contact your Zuora platform administrator.\n\n\ **Note**: The Credit and Debit Memos feature 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" tags: - Attachments 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: object-type in: path description: 'The type of the object to list attachements for. ' required: true type: string enum: - account - invoice - subscription - creditmemo - debitmemo - name: object-key in: path description: | ID of the object to list attachements for. - If `object-type` is `account`, specify an account ID or number. - If `object-type` is `invoice`, specify an invoice ID. - If `object-type` is `subscription`, specify a subscription number. - If `object-type` is `creditmemo`, specify a credit memo ID or number. - If `object-type` is `debitmemo`, specify a debit memo ID or number. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: attachments: - id: 402896b95397c169015397c2ebca0003 fileName: Search _ Splunk.pdf description: null fileId: 402896b95397c169015397c2ebc50002 fileContentType: application/pdf createdOn: '2016-03-21 14:00:47' createdBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2016-03-21 14:00:47' updatedBy: 402881e522cf4f9b0122cf5d82860002 success: true - id: 8a8083e1545b706a01547316d93f4401 fileName: AttachTest.txt description: '' fileId: 8a8083e1545b706a01547316d9094400 fileContentType: text/plain createdOn: '2016-05-02 13:09:17' createdBy: 4028e487327fd45a0132829ebb673ff9 updatedOn: '2016-05-02 13:09:17' updatedBy: 4028e487327fd45a0132829ebb673ff9 success: true description: '' schema: $ref: '#/definitions/GETAttachmentsResponseType' /v1/attachments/{attachment-id}: get: summary: Retrieve an attachment operationId: GET_Attachments description: | Use the View Attachment REST request to retrieve information about an attachment document. You can only use this operation if you have a Billing role that includes the Manage Attachments permission. For more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles). To change your Billing role, contact your Zuora platform administrator. tags: - Attachments 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: attachment-id in: path description: Id of the attachment you want to view. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a8083e1545b706a01547316d93f4401 fileName: AttachTest.txt description: '' fileId: 8a8083e1545b706a01547316d9094400 fileContentType: text/plain createdOn: '2016-05-02 13:09:17' createdBy: 4028e487327fd45a0132829ebb673ff9 updatedOn: '2016-05-02 13:09:17' updatedBy: 4028e487327fd45a0132829ebb673ff9 success: true description: '' schema: $ref: '#/definitions/GETAttachmentResponseType' put: summary: Update an attachment operationId: PUT_Attachments description: | Use the Edit Attachment REST request to make changes to the descriptive fields of an attachment, such as the description and the file name. You cannot change the actual content of the attached file in Zuora. If you need to change the actual content, you need to delete the attachment and add the updated file as a new attachment. You can only use this operation if you have a Billing role that includes the Manage Attachments permission. For more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles). To change your Billing role, contact your Zuora platform administrator. tags: - Attachments 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: attachment-id in: path required: true type: string description: Id of the attachment to be updated. - name: Request in: body description: '' required: false schema: $ref: '#/definitions/PUTAttachmentType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' delete: summary: Delete an attachment operationId: DELETE_Attachments description: | Use the Delete Attachment REST request to delete an attachment from a Zuora object. You can only use this operation if you have a Billing role that includes the Manage Attachments permission and the Delete Attachments permission. For more information, see [Billing roles](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles). To change your Billing role, contact your Zuora platform administrator. tags: - Attachments 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: attachment-id in: path required: true type: string description: Id of the attachment to be deleted. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /system-health/billing-documents/volume-summary: get: operationId: GET_SystemHealthBillingDocVolumeSummary summary: List billing document volume summary records description: 'Returns a summary of billing documents generated within a specified time range, including invoices and credit memos, and the total number of accounts that failed to process. ' tags: - Bill Run Health parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: startTime in: query required: true type: string format: date-time description: | Start time of the volume summary. Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`. - name: endTime in: query required: true type: string format: date-time description: | End time of the volume summary. Format: `yyyy-MM-dd'T'HH:mmZ` Example: `2022-09-22T09:07+0800`. responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetBillingDocVolumeSummaryResponse' examples: application/json: data: - totalGeneratedInvoices: 100 totalGeneratedCreditMemos: 50 totalFailedAccounts: 10 '400': description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/SystemHealthErrorResponse' examples: application/json: timestamp: '2022-09-29T05:54:46.007+00:00' status: 400 error: Bad Request message: Timezone is different between 'startTime' and 'endTime'. path: /system-health/billing-doc/volume-summary x-code-samples: - lang: curl label: Curl source: "curl -i -X GET \\\n 'https://rest.zuora.com/system-health/billing-documents/volume-summary?startTime=2022-09-22T09:07-0800&endTime=2022-09-24T09:07-0800'\ \ \\ \n -H 'Authorization: Bearer 7la16f1afa6f48099dc0605d7a175846'\n" /v1/bill-runs: post: summary: Create a bill run operationId: POST_CreateBillRun description: | Creates an ad-hoc bill run or a scheduled bill run. - Support to create ad-hoc or scheduled bill runs by batch - Support to create ad-hoc or scheduled bill runs for a single account (all subscriptions under this account) - Support to create a bill run by subscription (50 or less subscriptions under the same account) To use this operation, you must have the Create Bill Runs billing permission. **Restrictions and limitations** When using this operation to create bill runs, keep the following restrictions and limitations in mind: - When creating batch-level bill runs, you must specify `batches` and cannot specify `billRunFilters`. - When creating account-level bill runs, you must specify `billRunFilters` and cannot specify `batches`. Only one single account is allowed. - When creating subscription-level bill runs, you must specify `billRunFilters` and cannot specify `batches`. All subscriptions must belong to the same account. At most 50 subscriptions are allowed. - If more than 500 bill runs created through this operation are in `Pending` status, you cannot use this operation to create any more bill runs. tags: - Bill Run parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTCreateBillRunRequestType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetBillRunResponseType' /v1/bill-runs/{billRunId}/post: put: summary: Post a bill run operationId: PUT_PostBillRun description: | Posts a bill run asynchronously. To post a bill run, the current bill run must be in `Completed` status. When a bill run is being posted, its status is changed to `PostInProgress`. After all invoices for this bill run are posted, its status is changed to `Posted`. tags: - Bill Run 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: billRunId in: path required: true type: string description: 'The unique ID of a bill run. ' - name: Request in: body description: '' required: true schema: type: object properties: invoiceDate: type: string format: date description: "The date that appears on the invoice being created, in\ \ `yyyy-mm-dd` format. \n\nThe value cannot fall in a closed accounting\ \ period.\n" required: - invoiceDate example: invoiceDate: '2022-01-01' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetBillRunResponseType' /v1/bill-runs/{billRunId}: get: summary: Retrieve a bill run operationId: GET_BillRun description: 'Retrieves the information about a specific bill run. ' tags: - Bill Run 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: billRunId in: path description: 'The unique ID of a bill run. ' required: true type: string responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetBillRunResponseType' delete: summary: Delete a bill run operationId: DELETE_DeleteBillRun description: "Deletes a bill run. You can only delete bill runs in `Canceled`\ \ or `Error` status. \n" tags: - Bill Run 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: billRunId in: path required: true type: string description: 'The unique ID of a bill run. ' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GetBillRunResponseType' /v1/bill-runs/{billRunId}/cancel: put: summary: Cancel a bill run operationId: PUT_CancelBillRun description: | Cancels a bill run in Draft status. When cancelling a scheduled bill run, keep the following information in mind: - If you set `cancelOnce` to `true`, only the current bill run is cancelled. The other future scheduled bill runs will be automatically executed based on the schedule. - If you set `cancelOnce` to `false`, all future recurring bill runs are cancelled. tags: - Bill Run 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: billRunId in: path required: true type: string description: 'The unique ID of a bill run. ' - name: Request in: body description: '' required: true schema: type: object properties: cancelOnce: type: boolean default: true description: 'Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run. ' example: cancelOnce: true 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/CancelBillRunResponseType' /v1/bill-runs/{billRunKey}/emails: post: summary: Email billing documents generated from a bill run operationId: POST_EmailBillingDocumentsfromBillRun description: "Manually emails all the billing documents that are generated from\ \ a specified bill run to your customers. \n\n\nBill runs can generate invoices\ \ and credit memos based on your [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos).\ \ Credit memos are only available if you have the Invoice Settlement feature\ \ enabled.\n\n\nUsing this API operation, the billing documents are sent to\ \ the email addresses specified in the **To Email** field of the email templates.\ \ The email template used for each billing document is set in the **Delivery\ \ Options** panel of the **Edit notification** dialog from the Zuora UI. See\ \ [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)\ \ for more information about how to edit the **To Email** field in the email\ \ template.\n\n\n\n\n\n### Notes\n - Even though no field is required in\ \ the Request body, you still need to specify `{}` in the request. Otherwise,\ \ an error will be returned.\n\n\n - You can only email posted billing documents.\n\ \n\n - You must activate the following notifications before emailing invoices\ \ and credit memos:\n - **Manual Email For Invoice | Manual Email For Invoice**\ \ \n - **Email Credit Memo | Manually email Credit Memo**\n\n\n - To include\ \ the invoice PDF in the email, select the **Include Invoice PDF** check box\ \ in the **Edit notification** dialog from the Zuora UI. To include the credit\ \ memo PDF in the email, select the **Include Credit Memo PDF** check box\ \ in the **Edit notification** dialog from the Zuora UI. See [Create and Edit\ \ Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2)\ \ for more information.\n\n\n\n - Zuora sends the email messages based on\ \ the email template you set. You can set the email template to use in the\ \ **Delivery Options** panel of the **Edit notification** dialog from the\ \ Zuora UI. By default, the following templates are used for billing documents:\n\ \ - Invoices: **Invoice Posted Default Email Template**\n - Credit memos:\ \ **Manual Email for Credit Memo Default Template** \n\n See [Create and\ \ Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)\ \ for more information.\n" tags: - Bill Run 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: billRunKey in: path type: string required: true description: 'The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001. ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTEmailBillingDocfromBillRunType' /v1/accounts/{key}/billing-documents/generate: post: description: | Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled. **Note**: You cannot generate billing documents for cancelled or suspended subscriptions. summary: Generate billing documents by account ID operationId: POST_GenerateBillingDocuments tags: - Billing Documents 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: invoices: - id: 402890555c33b44b015c33bfe9c70044 - id: 402890555c33b44b015c33bfe9d70046 creditMemos: - id: 402890555c33b44b015c33bfe947003c - id: 402890555c33b44b015c33bfe93c003a success: true schema: $ref: '#/definitions/GenerateBillingDocumentResponseType' 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 description: '' required: true schema: $ref: '#/definitions/PostGenerateBillingDocumentType' - type: string in: path name: key description: 'The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001. ' required: true /v1/billing-documents: get: description: "Retrieves the information about all billing documents associated\ \ with a specified account. The billing documents contain invoices, credit\ \ memos, and debit memos.\n\nTo retrieve information about credit memos and\ \ debit memos, you must have the Invoice Settlement feature enabled. \n\n\ You can use query parameters to restrict the data returned in the response.\n\ \nExamples:\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate\n\ - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted\n\ - /billing-documents?accountNumber=A00000001&sort=+documentDate\n- /billing-documents?accountNumber=A00000001&status=Posted\n" summary: List billing documents for an account operationId: GET_BillingDocuments tags: - Billing Documents 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 required: false type: string format: uuid description: | The ID of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. - name: accountNumber in: query required: false type: string format: uuid description: | The number of the customer account that the billing documents are associated with. **Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters. - name: documentDate in: query required: false type: string format: date description: 'The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. ' - name: status in: query required: false type: string enum: - Draft - Posted - Canceled - Error description: 'The status of the billing document. ' - 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\nIf you do not specify any sortable field, the response data\ \ is sorted by the `documentDate` field in descending order.\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\n*field_name* indicates the name of a\ \ sortable field. The supported sortable fields of this operation are as\ \ below:\n\n - documentDate\n - documentType\n \nExamples:\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1\n\ \ &sort=+documentDate,-documentType\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1\n\ \ &status=Posted&sort=+documentDate&page=2&pageSize=15\n" 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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: documents: - id: 4028905f5e4jjj015e50af9aa002d1 documentType: Invoice documentNumber: INV-0000001 documentDate: '2017-10-01' amount: 100 balance: 90 accountId: 4028905f5e4feb38bbb50af9aa002d1 accountNumber: A00000001 status: Posted - id: 4028905f5e4jbbb015e50af9aa002d1 documentType: CreditMemo documentNumber: CM-0000001 documentDate: '2017-09-01' amount: 100 balance: 90 accountId: 4028905f5e4feb38b111b50af9aa002d1 accountNumber: A00000001 status: Posted - id: 4028905f5e4jccc015e50af9aa002d1 documentType: DebitMemo documentNumber: DM-0000001 documentDate: '2017-07-01' amount: 100 balance: 90 accountId: 4028905f5e4feb3833b50af9aa002d1 accountNumber: A00000001 status: Posted success: true schema: $ref: '#/definitions/BillingDocumentQueryResponseElementType' x-code-samples: - lang: curl label: Curl source: 'curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.sandbox.eu.zuora.com/v1/billing-documents?accountId=402892c74c9193cd014c91d35b0a0132" ' /v1/accounts/billing-documents/files/deletion-jobs: post: description: "Creates an asynchronous job to permanently delete all billing\ \ document PDF files for specific accounts. \n\nAfter the deletion job is\ \ completed, all billing document PDF files are permanently deleted. To retrieve\ \ the status of a deletion job, call [Retrieve a job of hard deleting billing\ \ document files](https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob).\n\ \n**Note**: This operation can be used only if you have the Billing user permission\ \ \"Hard Delete Billing Document Files\" enabled. \n" summary: Create a job to hard delete billing document files operationId: POST_BillingDocumentFilesDeletionJob tags: - Billing Documents 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/definitions/POSTBillingDocumentFilesDeletionJobResponse' 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 description: '' required: true schema: $ref: '#/definitions/POSTBillingDocumentFilesDeletionJobRequest' /v1/accounts/billing-documents/files/deletion-jobs/{jobId}: get: summary: Retrieve a job of hard deleting billing document files operationId: GET_BillingDocumentFilesDeletionJob description: "Retrieves information about an asynchronous job of permanently\ \ deleting all billing document PDF files for specific accounts.\n\n**Note**:\ \ This operation can be used only if you have the Billing user permission\ \ \"Hard Delete Billing Document Files\" enabled. \n" tags: - Billing Documents 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: jobId in: path description: The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true description: '' schema: $ref: '#/definitions/GETBillingDocumentFilesDeletionJobResponse' /v1/billing-preview-runs: post: summary: Create a billing preview run operationId: POST_BillingPreviewRun description: | Creates a billing preview run for multiple customer accounts. The maximum supported preview duration is 20 years, calculated from the current date to the target date. You can run up to 20 billing preview runs in batches concurrently. A single batch of customer accounts can only have one billing preview run at a time. So you can have up to 20 batches running at the same time. If you create a billing preview run for all customer batches, you cannot create another billing preview run until this preview run is completed. Note that the preview results for each billing preview run will be stored in the system for 180 days; after that they will be purged. parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `batch`\n* `batches`\ \ \n" - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PostBillingPreviewRunParam' tags: - Billing Preview Run 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true billingPreviewRunId: 402890b757d1ec1b0157d5aa3d6802aa description: '' schema: type: object properties: success: type: boolean description: 'Returns `true` if the request was processed successfully. ' billingPreviewRunId: type: string description: 'Id of the billing preview run. ' /v1/billing-preview-runs/{billingPreviewRunId}: get: summary: Retrieve a billing preview run operationId: GET_BillingPreviewRun description: "Retrieves a preview of future invoice items for multiple customer\ \ accounts through a billing preview run. If you have the Invoice Settlement\ \ feature enabled, you can also retrieve a preview of future credit memo\ \ items. 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\nA billing preview run asynchronously generates\ \ a downloadable CSV file containing a preview of invoice item data and credit\ \ memo item data for a batch of customer accounts. Note that if you set `storageOption`\ \ to `Database`, no CSV file is generate; instead, you can have a record in\ \ the billing preview result. You can use data source to query Billing Preview Run Result. \n" parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `batch`\n* `batches`\n" - name: billingPreviewRunId in: path description: 'Id of the billing preview run. ' required: true type: string tags: - Billing Preview Run 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: assumeRenewal: Autorenew batches: '' chargeTypeToExclude: OneTime createdById: 4028906d58240f960158241132be0003 createdDate: '2016-11-04 16:18:56' endDate: '2016-11-04 16:19:00' errorMessage: null includingEvergreenSubscription: true includingDraftItems: false resultFileUrl: https://rest.zuora.com/v1/files/4028906d582d21a101582e6b663c0a65 runNumber: BPR-00000010 startDate: '2016-11-04 16:19:00' status: Completed succeededAccounts: 7 targetDate: '2016-12-01' totalAccounts: 7 updatedById: 4028906d58240f960158241132be0003 updatedDate: '2016-11-04 16:19:00' success: true description: '' schema: $ref: '#/definitions/GetBillingPreviewRunResponse' /v1/catalog-groups: post: summary: Create a catalog group operationId: POST_CreateCatalogGroup description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Creates a catalog group which groups a list of product rate plans. tags: - Catalog Groups parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTCatalogGroupRequest' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test description: some description catalogGroupNumber: CG-00000001 type: Grading productRatePlans: - id: 4028e5ab7f1b600c017f1b787d5d01cf status: Active name: '222' description: null effectiveStartDate: '2022-02-21' effectiveEndDate: '2023-02-21' grade: 1 description: '' schema: $ref: '#/definitions/CatalogGroupResponse' get: summary: List all catalog groups operationId: GET_ListAllCatalogGroups description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Retrieves basic information about all catalog groups. tags: - Catalog Groups parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/parameters/GLOBAL_REQUEST_page' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: catalogGroups: - id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test description: some description catalogGroupNumber: CG-00000001 type: Grading productRatePlans: - id: 4028e5ab7f1b600c017f1b787d5d01cf status: Active name: '222' description: null effectiveStartDate: '2022-02-21' effectiveEndDate: '2023-02-21' grade: 1 nextPage: false description: '' schema: $ref: '#/definitions/ListAllCatalogGroupsResponse' /v1/catalog-groups/{catalog-group-key}: get: summary: Retrieve a catalog group operationId: GET_RetrieveCatalogGroup description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Retrieves basic information about a catalog group. tags: - Catalog Groups 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: catalog-group-key in: path description: 'The unique number or ID of the catalog group to be retrieved. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test description: some description catalogGroupNumber: CG-00000001 type: Grading productRatePlans: - id: 4028e5ab7f1b600c017f1b787d5d01cf status: Active name: '222' description: null effectiveStartDate: '2022-02-21' effectiveEndDate: '2023-02-21' grade: 1 description: '' schema: $ref: '#/definitions/CatalogGroupResponse' put: summary: Update a catalog group operationId: PUT_UpdateCatalogGroup description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Updates a catalog group by its unique number or ID. ### Notes - It is best practice to only specify the fields that you want to change in the request body. - If you specify an empty value for a field in the request body, the corresponding field in the catalog group is emptied. - The catalog group type cannot be changed. tags: - Catalog Groups 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: catalog-group-key in: path required: true type: string description: "The unique number or ID of the catalog group to be updated.\ \ \n" - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTCatalogGroup' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 4028e5ab7f1b600c017f1b7a5e8901d2 name: test description: some description catalogGroupNumber: CG-00000001 type: Grading productRatePlans: - id: 4028e5ab7f1b600c017f1b787d5d01cf status: Active name: '222' description: null effectiveStartDate: '2022-02-21' effectiveEndDate: '2023-02-21' grade: 1 description: '' schema: $ref: '#/definitions/CatalogGroupResponse' delete: summary: Delete a catalog group operationId: DELETE_CatalogGroup description: | **Note**: This operation is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. If you want to join this early adopter program, submit a request at [Zuora Global Support](http://support.zuora.com/). Deletes a catalog group. tags: - Catalog Groups 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: catalog-group-key in: path description: 'The unique number or ID of the catalog group to be deleted. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: 'true' description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/catalog/products: get: summary: List all products operationId: GET_Catalog description: "Retrieves the entire product catalog, including all products,\ \ features, and their corresponding product rate plans, charges. Products\ \ are returned in reverse chronological order on the `UpdatedDate` field.\ \ \n\nFor each product, this operation returns a maximum of 300 product rate\ \ plans in the response. Across the returned product rate plans, up to 300\ \ product rate plan charges can be returned for each product. \n" tags: - Catalog 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_catalog' - name: zuora-version in: header required: false type: string description: "The minor version of the Zuora REST API. \n\nYou only need to\ \ set this parameter if you use the `productRatePlans` field.\n" 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: products: - id: 8a8082c45aa81b51015ad5a2d07d0e89 sku: SKU-00000987 name: ABC description: '' category: Base Products effectiveStartDate: '2017-01-01' effectiveEndDate: '2020-01-01' productNumber: PC-00000011 productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan success: true description: '' schema: $ref: '#/definitions/GETCatalogType' /v1/catalog/products/{product-key}: get: summary: Retrieve a product operationId: GET_Product description: "Retrieves detailed information about a specific product, including\ \ information about its product rate plans and charges. \n\nThis operation\ \ returns a maximum of 300 product rate plans and 300 product rate plan charges\ \ across all product rate plans in the response.\n" tags: - Catalog parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "The minor version of the Zuora REST API. \n\nYou only need to\ \ set this parameter if you use the `productRatePlans` field.\n" - name: product-key in: path description: 'The unique ID, SKU, or product number of the product that you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe, SKU-00000987, or PC-00000006. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: id: 8a8082c45aa81b51015ad5a2d07d0e89 sku: SKU-00000987 name: ABC description: '' category: Base Products effectiveStartDate: '2017-01-01' effectiveEndDate: '2020-01-01' productRatePlans: https://rest.zuora.com/v1/rateplan/40289f466463d683016463ef8b7301a0/productRatePlan productNumber: PC-00000006 success: true description: '' schema: $ref: '#/definitions/GETProductType' /deployment-manager/deployment_templates: post: summary: Create a deployment template operationId: POST_DeploymentTemplate description: | Creates templates based on user preference. There are 2 ways to select components. - Selecting the whole component. - Advanced Options -> which helps user to select specific components to be migrated. It takes the enviroment details from the logged in user automatically, while creating the template. tags: - Configuration Templates 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: request required: true in: body description: CreateTemplateRequestContent JSON object which contains the details to create a template. schema: $ref: '#/definitions/CreateTemplateRequestContent' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: id: 210656b3-0d89-4bc6-92b9-634653e729af name: Test_Template description: '' status: Inprogress errors: '-' active: true tenantName: Data Connect entityName: Global environment: US-API-Sandbox-Staging createdBy: Daco user createdOn: '2022-09-14T16:06:43.155Z' content: null description: Successfully created the template. schema: $ref: '#/definitions/TemplateDetailResponse' '201': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: | created. The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field. '400': description: Bad Request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Not Found schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' get: summary: List all templates operationId: GET_Templates description: 'Retrieves all the templates and their details which are created already. ' tags: - Configuration Templates parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: templates: - id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 name: Testing Tax description: '' status: DONE errors: '-' active: true tenantName: Data Connect entityName: Global environment: US-API-Sandbox-Staging createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' content: null - id: 24ba307c-cd94-4b9f-b849-c2d08f028c53 name: tempExample3975161566467657 description: '' status: DONE errors: '-' active: true tenantName: Data Connect entityName: Global environment: US-API-Sandbox-Staging createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' content: null description: Successfully received all templates throught Template Response Object. schema: $ref: '#/definitions/TemplateResponse' '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Not Found schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /deployment-manager/deployment_templates/{id}: get: summary: List all details of a template operationId: GET_DeploymentTemplateDetail description: 'Returns the detailed information of a specific template by passing its template ID. ' tags: - Configuration Templates parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: The ID of the template that needs to be retrieved. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 name: Testing Tax description: '' status: DONE errors: '-' active: true tenantName: Data Connect entityName: Global environment: US-API-Sandbox-Staging createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' content: settings: - segregationKeys: - Administration - ManageDataAccessControl - Finance - Billing - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration originalPayload: null response: - id: 301e73b7-420c-4770-9c37-3d966c1e2690 key: AccountingRules segregationKey: Finance componentType: Settings url: /accounting-rules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowUsageInClosedPeriod: false allowRevenueScheduleNegativeAmounts: false result: DONE error: null templateId: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 errors: [] productCatalog: [] notifications: [] workflows: [] customFields: [] dataAccessControl: [] customObjects: [] description: Successfully received the template. schema: $ref: '#/definitions/TemplateDetailResponse' '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Not Found schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' delete: summary: Delete a template operationId: DELETE_DeploymentTemplate description: 'Deletes a specific template by passing the ID. ' tags: - Configuration Templates parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: The ID of the template that needs to be deleted. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Successfully deleted the template. '204': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: No Content '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Id is invalid schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /deployment-manager/deployment_artifacts: get: summary: Download a template operationId: GET_DownloadDeploymentTemplate description: 'Download a template for migration in the Deployment manager from the source tenant to the target tenant. ' tags: - Configuration Templates parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: deployment_template_id in: query description: Id which template needs to be downloaded. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: {} description: Successfully downloaded the template. schema: $ref: '#/definitions/JsonNode' '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Id is invalid schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /deployment-manager/deployment_artifacts/retrieve-settings: get: summary: List all details of source components operationId: GET_SourceComponentDetails description: 'When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc. ' tags: - Configuration Templates parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: customFields: - segregationKeys: - Account - Invoice - InvoiceItem - AccountingCode - ProductRatePlanCharge - ProductFeature - Product - JournalEntry - RatePlan - Amendment - DebitTaxationItem - Subscription - Order - Usage - ProductRatePlan - AccountingPeriod - CreditMemoItem - RevenueSchedule - RatePlanCharge - Contact - OrderAction - Payment - CreditBalanceAdjustment - Refund - DebitMemo originalPayload: definitions: Account: type: Account schema: type: object properties: idx_date_1__c: format: date label: idx_date_1 type: string description: test createdDate: '2022-08-18T12:38:13.000Z' updatedDate: '2022-08-18T12:38:13.000Z' non_idx_text_1__c: maxLength: 50 label: non_idx_text_1 type: string description: non_idx_text_1 default: non_idx_text_1 createdDate: '2022-08-18T12:38:14.000Z' updatedDate: '2022-08-18T12:38:14.000Z' Last_Token_Transaction_Date__c: maxLength: 255 label: Last_Token_Transaction_Date type: string description: '' createdDate: '2022-08-22T19:30:10.000Z' updatedDate: '2022-08-22T19:30:10.000Z' CollectionsAgent__c: maxLength: 255 label: Collections Agent type: string description: '' default: abc createdDate: '2022-08-22T18:16:38.000Z' updatedDate: '2022-08-22T18:16:38.000Z' InCollections__c: maxLength: 25 label:

type: string description: '' createdDate: '2022-08-18T12:38:04.000Z' updatedDate: '2022-08-18T12:38:04.000Z' indexed: - Last_Token_Transaction_Date__c - idx_date_1__c readOnlyOnUI: - idx_date_1__c - non_idx_text_1__c additionalProperties: false AccountingCode: type: AccountingCode schema: type: object properties: AccountingCodeCustomText__c: maxLength: 64 label: AccountingCodeCustomText type: string default: custom text createdDate: '2022-02-01T08:41:03.000Z' updatedDate: '2022-02-01T08:41:03.000Z' AccountingCodeCustomDate__c: format: date label: AccountingCodeCustomDate type: string createdDate: '2022-02-08T07:20:15.000Z' updatedDate: '2022-02-08T07:20:15.000Z' AccountingCodeCustomPickList__c: enum: - Alpha - Beta - Omega label: AccountingCodeCustomPickList type: string default: Alpha createdDate: '2022-02-08T07:20:18.000Z' updatedDate: '2022-02-08T07:20:18.000Z' additionalProperties: false count: 2 response: - id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a key: idx_date_1 segregationKey: Account componentType: CustomFields url: '-' method: GET payload: label: idx_date_1 description: test format: date API_name: idx_date_1__c UIReadOnly: true indexed: true result: DONE error: '-' templateId: null errors: [] customObjects: - segregationKeys: - Available Custom Objects originalPayload: {} response: - id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz segregationKey: Available Custom Objects componentType: CustomObjects url: /zzzzzzzzzz method: GET payload: label: zzzzzzzzzz api_name: zzzzzzzzzz description: ' ' enableRecordMigration: 'false' customFields: - description: ' ' type: boolean api_name: isFilterable__c field_name: isFilterable required: 'false' filterable: 'true' - description: ' ' type: string api_name: picklist__c field_name: picklist required: 'false' filterable: 'false' - description: ' ' type: string api_name: zzz__c field_name: zzz required: 'false' filterable: 'false' result: DONE error: '-' templateId: null errors: [] dataAccessControl: - errors: [] originalPayload: {} response: - componentType: dataAccessControl error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: {} result: DONE segregationKey: Available dataAccessControl templateId: null url: /zzzzzzzzzz segregationKeys: - Available dataAccessControl notifications: - segregationKeys: - Communication profile - Email Templates originalPayload: 2c92c8fb7ddc795b017dde4350c949a0: - id: 2c92c8fb7ddc795b017dde437a0949a6 profileId: 2c92c8fb7ddc795b017dde4350c949a0 eventId: 2c92c8f9631ea3850163271f7fa02da0 eventName: New Invoice Posted name: Invoice Posted within a Bill Run of Auto-Post description: Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run. active: false hidden: false param1: BILLRUN param4: Not include invoice PDF emailOption: true emailTemplate: 2c92c8f9631ea3850163271f80152de2 emailTemplateName: Invoice Posted Default Email Template calloutOption: false contentType: APPLICATION_JSON calloutRetriable: false calloutAuth: false calloutOauth2: false calloutPreemptiveAuth: false useCustomRequestBody: false response: - id: f5ee9c26-8420-4f92-9463-1983d1268281 key: B2C Customers segregationKey: Communication profile componentType: Notifications url: settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0 method: GET payload: id: 2c92c8fb7ddc795b017dde4350c949a0 name: B2C Customers locale: default description: '' isDefault: false result: DONE error: '-' templateId: null errors: [] productCatalog: - errors: [] originalPayload: {} response: - componentType: productCatalog error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: {} result: DONE segregationKey: Available productCatalog templateId: null url: /zzzzzzzzzz segregationKeys: - Available productCatalog settings: - segregationKeys: - Finance - Billing - Administration - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration - ManageDataAccessControl originalPayload: {} response: - id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6 key: AccountingPeriods segregationKey: Finance componentType: Settings url: v1/accounting-periods method: GET payload: {} result: FAILED error: '{"success":false,"reasons":[{"message":"Failed to get user info","code":"90000011"}]} ' templateId: null - id: 6a27d0d3-3c4c-408f-b160-04510014ebf1 key: AccountingRules segregationKey: Finance componentType: Settings url: /accounting-rules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowUsageInClosedPeriod: false allowRevenueScheduleNegativeAmounts: false result: DONE error: null templateId: null errors: [] workflows: - segregationKeys: - Payment to Provision - Negative Invoices to Positive Account Credit Balance Limit 1 - Automated Dunning | 2nd Attempt Failed - Subscription Price Uplift -- JSON Transform originalPayload: {} response: - id: df74980b-ff25-4684-a950-7e0c25810a72 key: Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13 segregationKey: Resume Subscriptions for Accounts with Zero Balance Limit 1 componentType: WorkFlows url: '1' method: GET payload: id: 1 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 description: '' status: Active ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-08-21T10:51:22.613-07:00' updatedAt: '2022-08-21T10:51:22.613-07:00' priority: Medium active_version: id: 2483 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 definitionId: 1 description: '' type: Workflow::Setup version: 0.0.13 ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-08-21T10:51:22.613-07:00' updatedAt: '2022-08-21T10:51:22.613-07:00' priority: Medium status: Active created_by: work_email: rkumar@zuora.com created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' updated_by: work_email: N/A created_at: N/A updated_at: N/A latest_inactive_versions: - id: 689 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 definitionId: 1 description: '' type: Workflow::Setup version: 0.0.10 ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-05-10T05:21:37.192-07:00' updatedAt: '2022-05-10T05:21:37.192-07:00' priority: Medium status: Inactive created_by: work_email: rkumar@zuora.com created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' updated_by: work_email: N/A created_at: N/A updated_at: N/A result: DONE error: '-' templateId: null errors: [] description: Successfully retrieved the template metadata. schema: $ref: '#/definitions/SettingSourceComponentResponse' '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Id is invalid schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /deployment-manager/deployment_artifacts/compare: post: summary: Compare settings between a source tenant and a target tenant operationId: POST_CompareTemplate consumes: - multipart/form-data produces: - application/json description: 'To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant. ' tags: - Configuration Templates 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: tenant in: query description: Customers need to specify tenant ID. required: true type: string - name: template in: formData description: Template contains the config metadata and target tenant information. required: false type: file responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: customFields: - segregationKeys: - Account - Invoice - InvoiceItem - AccountingCode - ProductRatePlanCharge - ProductFeature - Product - JournalEntry - RatePlan - Amendment - DebitTaxationItem - Subscription - Order - Usage - ProductRatePlan - AccountingPeriod - CreditMemoItem - RevenueSchedule - RatePlanCharge - Contact - OrderAction - Payment - CreditBalanceAdjustment - Refund - DebitMemo originalPayload: definitions: Account: type: Account schema: type: object properties: idx_date_1__c: format: date label: idx_date_1 type: string description: test createdDate: '2022-08-18T12:38:13.000Z' updatedDate: '2022-08-18T12:38:13.000Z' non_idx_text_1__c: maxLength: 50 label: non_idx_text_1 type: string description: non_idx_text_1 default: non_idx_text_1 createdDate: '2022-08-18T12:38:14.000Z' updatedDate: '2022-08-18T12:38:14.000Z' Last_Token_Transaction_Date__c: maxLength: 255 label: Last_Token_Transaction_Date type: string description: '' createdDate: '2022-08-22T19:30:10.000Z' updatedDate: '2022-08-22T19:30:10.000Z' CollectionsAgent__c: maxLength: 255 label: Collections Agent type: string description: '' default: abc createdDate: '2022-08-22T18:16:38.000Z' updatedDate: '2022-08-22T18:16:38.000Z' InCollections__c: maxLength: 25 label:
type: string description: '' createdDate: '2022-08-18T12:38:04.000Z' updatedDate: '2022-08-18T12:38:04.000Z' indexed: - Last_Token_Transaction_Date__c - idx_date_1__c readOnlyOnUI: - idx_date_1__c - non_idx_text_1__c additionalProperties: false AccountingCode: type: AccountingCode schema: type: object properties: AccountingCodeCustomText__c: maxLength: 64 label: AccountingCodeCustomText type: string default: custom text createdDate: '2022-02-01T08:41:03.000Z' updatedDate: '2022-02-01T08:41:03.000Z' AccountingCodeCustomDate__c: format: date label: AccountingCodeCustomDate type: string createdDate: '2022-02-08T07:20:15.000Z' updatedDate: '2022-02-08T07:20:15.000Z' AccountingCodeCustomPickList__c: enum: - Alpha - Beta - Omega label: AccountingCodeCustomPickList type: string default: Alpha createdDate: '2022-02-08T07:20:18.000Z' updatedDate: '2022-02-08T07:20:18.000Z' additionalProperties: false count: 2 response: - id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a key: idx_date_1 segregationKey: Account componentType: CustomFields url: '-' method: GET payload: label: idx_date_1 description: test format: date API_name: idx_date_1__c UIReadOnly: true indexed: true result: DONE error: '-' templateId: null errors: [] customObjects: - segregationKeys: - Available Custom Objects originalPayload: {} response: - id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz segregationKey: Available Custom Objects componentType: CustomObjects url: /zzzzzzzzzz method: GET payload: label: zzzzzzzzzz api_name: zzzzzzzzzz description: ' ' enableRecordMigration: 'false' customFields: - description: ' ' type: boolean api_name: isFilterable__c field_name: isFilterable required: 'false' filterable: 'true' - description: ' ' type: string api_name: picklist__c field_name: picklist required: 'false' filterable: 'false' - description: ' ' type: string api_name: zzz__c field_name: zzz required: 'false' filterable: 'false' result: DONE error: '-' templateId: null errors: [] dataAccessControl: - errors: [] originalPayload: {} response: - componentType: dataAccessControl error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: {} result: DONE segregationKey: Available dataAccessControl templateId: null url: /zzzzzzzzzz segregationKeys: - Available dataAccessControl notifications: - segregationKeys: - Communication profile - Email Templates originalPayload: 2c92c8fb7ddc795b017dde4350c949a0: - id: 2c92c8fb7ddc795b017dde437a0949a6 profileId: 2c92c8fb7ddc795b017dde4350c949a0 eventId: 2c92c8f9631ea3850163271f7fa02da0 eventName: New Invoice Posted name: Invoice Posted within a Bill Run of Auto-Post description: Trigger the notification when invoices are posted within a bill run and the bill run has auto-post. This is to support existing email notification behavior from within a bill run. active: false hidden: false param1: BILLRUN param4: Not include invoice PDF emailOption: true emailTemplate: 2c92c8f9631ea3850163271f80152de2 emailTemplateName: Invoice Posted Default Email Template calloutOption: false contentType: APPLICATION_JSON calloutRetriable: false calloutAuth: false calloutOauth2: false calloutPreemptiveAuth: false useCustomRequestBody: false response: - id: f5ee9c26-8420-4f92-9463-1983d1268281 key: B2C Customers segregationKey: Communication profile componentType: Notifications url: settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0 method: GET payload: id: 2c92c8fb7ddc795b017dde4350c949a0 name: B2C Customers locale: default description: '' isDefault: false result: DONE error: '-' templateId: null errors: [] productCatalog: - errors: [] originalPayload: {} response: - componentType: productCatalog error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: {} result: DONE segregationKey: Available productCatalog templateId: null url: /zzzzzzzzzz segregationKeys: - Available productCatalog settings: - segregationKeys: - Finance - Billing - Administration - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration - ManageDataAccessControl originalPayload: {} response: - id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6 key: AccountingPeriods segregationKey: Finance componentType: Settings url: v1/accounting-periods method: GET payload: {} result: FAILED error: '{"success":false,"reasons":[{"message":"Failed to get user info","code":"90000011"}]} ' templateId: null - id: 6a27d0d3-3c4c-408f-b160-04510014ebf1 key: AccountingRules segregationKey: Finance componentType: Settings url: /accounting-rules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowUsageInClosedPeriod: false allowRevenueScheduleNegativeAmounts: false result: DONE error: null templateId: null errors: [] workflows: - segregationKeys: - Payment to Provision - Negative Invoices to Positive Account Credit Balance Limit 1 - Automated Dunning | 2nd Attempt Failed - Subscription Price Uplift -- JSON Transform originalPayload: {} response: - id: df74980b-ff25-4684-a950-7e0c25810a72 key: Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13 segregationKey: Resume Subscriptions for Accounts with Zero Balance Limit 1 componentType: WorkFlows url: '1' method: GET payload: id: 1 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 description: '' status: Active ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-08-21T10:51:22.613-07:00' updatedAt: '2022-08-21T10:51:22.613-07:00' priority: Medium active_version: id: 2483 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 definitionId: 1 description: '' type: Workflow::Setup version: 0.0.13 ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-08-21T10:51:22.613-07:00' updatedAt: '2022-08-21T10:51:22.613-07:00' priority: Medium status: Active created_by: work_email: rkumar@zuora.com created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' updated_by: work_email: N/A created_at: N/A updated_at: N/A latest_inactive_versions: - id: 689 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 definitionId: 1 description: '' type: Workflow::Setup version: 0.0.10 ondemandTrigger: true calloutTrigger: true scheduledTrigger: false interval: null timezone: null createdAt: '2022-05-10T05:21:37.192-07:00' updatedAt: '2022-05-10T05:21:37.192-07:00' priority: Medium status: Inactive created_by: work_email: rkumar@zuora.com created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' updated_by: work_email: N/A created_at: N/A updated_at: N/A result: DONE error: '-' templateId: null errors: [] description: OK schema: $ref: '#/definitions/CompareSchemaInfoResponse' '201': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: | created. The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field. '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Not Found schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /deployment-manager/deployment_artifacts/deploy: post: summary: Migrate settings from source tenant to target tenant operationId: POST_MigrateTenantSettings description: 'To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen. ' tags: - Configuration Templates 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: tenant in: query description: Customers need to specify tenant ID in query parameter. required: true type: string - in: body name: request description: Request Details. required: true schema: $ref: '#/definitions/TemplateMigrationClientRequest' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' examples: application/json: emailIds: daco@zuora.com environment: US-API-Sandbox-Staging id: aa7b4ffa-f30c-4f42-b240-9534f634e14f migratedBy: Daco user migrationDescription: Migration from/to Sandbox migrationEnd: '2020-11-01 18:00:00' migrationName: Job A migrationStart: '2020-11-01 18:00:00' response: [] sourceTenantDescription: Jren-Stage sourceTenantName: Payment Gateway Test Tenant status: DONE type: Tenant description: Successfully migrated from source to target. schema: $ref: '#/definitions/MigrationClientResponse' '201': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: | created. The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URL(s) returned in the entity of the response, with the most specific URL for the resource given by a Location header field. '400': description: Bad request schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '401': description: Unauthorized schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '403': description: Forbidden schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' '404': description: Not Found schema: $ref: '#/definitions/ConfigTemplateErrorResponse' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. Zuora would return the same tracing identifier if you specified it in the request headers. Otherwise, Zuora does not set this header. ' /v1/contact-snapshots/{contact-snapshot-id}: get: tags: - Contact Snapshots summary: Retrieve a contact snapshot description: 'Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact. ' operationId: GET_ContactSnapshot 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: contact-snapshot-id in: path description: 'The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab. ' required: true type: string responses: '200': description: '' examples: application/json: address1: 4th street Custom colony address2: Thoraipakkam city: Chennai contactId: 4028c7628741ebe3018745f2c4123514 country: India county: null fax: 43212 firstName: Pat homePhone: 09877 id: 4028c7628741ebe3018745f2c4133515 lastName: Parker mobilePhone: 1234567890 nickname: this is a nick name otherPhone: 9876543210 otherPhoneType: Work personalEmail: test123@gmail.com state: TN taxRegion: null workEmail: test123@zuora.com workPhone: 123 postalCode: 123456 description: null success: true 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GETContactSnapshotResponse' /v1/contacts/{contactId}/scrub: put: summary: Scrub a contact operationId: PUT_ScrubContact description: "\nScrubs the sensitive data of a specific contact. \n\nYou can\ \ use this operation to replace all sensitive data in a contact and its related\ \ contact snapshot with dummy values that will be stored in Zuora databases.\ \ \n\nAfter scrubbing a contact, it is good practice to delete it. Otherwise,\ \ it might cause errors in subsequent operations.\n\n**Note**: To use this\ \ operation, you must ensure that the \"Scrub Sensitive Data of Contact\"\ \ billing permission is enabled in your user role. Contact your tenant administrator\ \ if you want to enable this permission. See [Scrub Contacts](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/A_How_to_Manage_Customer_Accounts/B_Key_Contacts/Scrub_Contacts)\ \ for more information.\n" tags: - Contacts 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_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: contactId in: path description: 'The ID of the contact that you want to scrub sensitive data from. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/contacts: post: summary: Create a contact operationId: POST_CreateContact description: 'Creates a contact for a specified account. ' tags: - Contacts parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/POSTContactType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: accountId: 6e767220676e6e61206776652075207570 accountNumber: A00000001 address1: 314, Bongora address2: near Tech City city: GHY country: India county: null fax: '6174' firstName: Kuhi homePhone: '1234123' id: 6b65657020726f6c6c696e672021 lastName: Das mobilePhone: '123213' nickname: Dorimi otherPhone: '2314213' otherPhoneType: Work personalEmail: kuhiroll@example.com state: Assam taxRegion: null workEmail: null workPhone: null zipCode: '123456' contactDescription: This is a description for the contact success: true description: '' schema: $ref: '#/definitions/ContactResponse' /v1/contacts/{contactId}: get: summary: Retrieve a contact operationId: GET_Contact description: 'Retrieves detailed information about a specific contact. ' tags: - Contacts 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_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: contactId in: path description: 'The ID of the contact that you want to retrieve. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: accountId: 72756e2061726e642026206465736572742075 accountNumber: A00000001 address1: 567, Rose Apartment address2: Gate no. 2 city: Seattle country: United States county: King County fax: '123456' firstName: peter homePhone: '86123456789' id: 402881a2889f2e4301889f30e64e0019 lastName: parker mobilePhone: '1234567890' nickname: peet otherPhone: '11111111111111111' otherPhoneType: Work personalEmail: peet@example.com state: Washington taxRegion: CA workEmail: work.mail@example.com workPhone: '3432' zipCode: '123134' contactDescription: This is a description success: true description: '' schema: $ref: '#/definitions/ContactResponse' put: summary: Update a contact operationId: PUT_Contact description: | Updates a contact for a specified account. You can update contacts for cancelled accounts. tags: - Contacts 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_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: contactId in: path description: 'The ID of the contact that you want to update. ' required: true type: string - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTContactType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: accountId: 6e767220676e6e61206d616b65207520637279 accountNumber: A00000001 address1: new Address address2: near Tech City city: Mumbai country: India county: null fax: '6174' firstName: Kuhi homePhone: '1234123' id: 8a90f50888a3036e0188ab7b3ffe7b8a lastName: Das mobilePhone: '123213' nickname: Dorimi otherPhone: '2314213' otherPhoneType: Work personalEmail: kuhiroll@example.com state: Assam taxRegion: null workEmail: null workPhone: null zipCode: '123134' contactDescription: This is the new Description success: true description: '' schema: $ref: '#/definitions/ContactResponse' delete: summary: Delete a contact operationId: DELETE_Contact description: 'Deletes a contact. ' tags: - Contacts 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_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: contactId in: path description: 'The ID of the contact that you want to delete. ' required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/creditmemos: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCreates an ad-hoc credit memo from a product rate\ \ plan charge. Zuora supports the creation of credit memos from any type of\ \ product rate plan charge. The charges can also have any amount and any charge\ \ model, except for discout charge models. \n\nWhen credit memos are created\ \ from product rate plan charges, the specified amount with decimal places\ \ is now validated based on the decimal places supported by each currency.\n\ \nYou can create a credit memo only if you have the user permission. See [Billing\ \ Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Create a credit memo from a charge operationId: POST_CreditMemoFromPrpc tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a87d7f5015a88c7a6830022 number: CM00000015 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 currency: USD creditMemoDate: '2017-10-17' targetDate: null postedById: null postedOn: null status: Draft amount: 2020 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 2020 refundAmount: 0 appliedAmount: 0 comment: the comment source: AdhocFromPrpc sourceType: Standalone sourceId: null referredInvoiceId: null reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-01 15:31:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:31:10' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false excludeItemBillingFromRevenueAccounting: true autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `charges` > `amount`\n\ * `charges` > `memoItemAmount`\n* `charges` > `chargeId`\n* `charges` >\ \ `productRatePlanChargeId` \n* `charges` > `comment`\n* `charges`\ \ > `description`\n* `customRates` > `currency`\n* `customRates` > `customFxRate`\ \ \n* `customRates` > `rateDate` \n" - name: body in: body description: '' required: true schema: $ref: '#/definitions/CreditMemoFromChargeType' get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about all credit memos.\ \ \n\nFor a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).\n\ \n\n### Filtering\n\nYou can use query parameters to restrict the data returned\ \ in the response. Each query parameter corresponds to one field in the response\ \ body.\n\nIf the value of a filterable field is string, you can set the corresponding\ \ query parameter to `null` when filtering. Then, you can get the response\ \ data with this field value being `null`. \n \nExamples:\n\n- /v1/creditmemos?status=Posted\n\ \n- /v1/creditmemos?referredInvoiceId=null&status=Draft\n\n- /v1/creditmemos?status=Posted&type=External&sort=+number\n" summary: List credit memos operationId: GET_CreditMemos tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: creditmemos: - id: 2c92c8f95bd63b94015bd7c39289112e number: CM00000002 accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 currency: USD creditMemoDate: '2017-05-05' targetDate: null postedById: null postedOn: null status: Draft amount: 23 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 23 refundAmount: 0 appliedAmount: 0 comment: '' source: BillRun sourceType: Standalone sourceId: BR-00000024 referredInvoiceId: null reasonCode: Correcting invoice error reversed: false createdDate: '2017-05-05 01:39:30' createdById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:39:30' updatedById: 2c92c8f95b79c9ad015b80614273052c cancelledOn: null cancelledById: null latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023 transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null - id: 2c92c8f95bd63b9d015bd7ad7fe206f9 number: CM00000001 accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 currency: USD creditMemoDate: '2017-05-01' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: '' source: AdhocFromInvoice sourceType: Standalone sourceId: null referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab reasonCode: Correcting invoice error reversed: false createdDate: '2017-05-05 01:15:23' createdById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:15:24' updatedById: 2c92c8f95b79c9ad015b80614273052c cancelledOn: null cancelledById: null latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoCollectionType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - name: accountId in: query type: string required: false description: 'This parameter filters the response based on the `accountId` field. ' - name: accountNumber in: query type: string required: false description: 'This parameter filters the response based on the `accountNumber` field. ' - name: amount in: query type: number format: double required: false description: "This parameter filters the response based on the `amount` field.\ \ \n" - name: appliedAmount in: query type: number format: double required: false description: "This parameter filters the response based on the `appliedAmount`\ \ field. \n" - name: autoApplyUponPosting in: query type: boolean required: false description: "This parameter filters the response based on the `autoApplyUponPosting`\ \ field. \n" - name: createdById in: query type: string required: false description: "This parameter filters the response based on the `createdById`\ \ field. \n" - name: createdDate in: query type: string format: date-time required: false description: "This parameter filters the response based on the `createdDate`\ \ field. \n" - name: creditMemoDate in: query type: string format: date required: false description: "This parameter filters the response based on the `creditMemoDate`\ \ field. \n" - name: currency in: query type: string required: false description: "This parameter filters the response based on the `currency`\ \ field. \n" - name: excludeFromAutoApplyRules in: query type: boolean required: false description: "This parameter filters the response based on the `excludeFromAutoApplyRules`\ \ field. \n" - name: number in: query type: string required: false description: "This parameter filters the response based on the `number` field.\ \ \n" - name: referredInvoiceId in: query type: string required: false description: "This parameter filters the response based on the `referredInvoiceId`\ \ field. \n" - name: refundAmount in: query type: number format: double required: false description: "This parameter filters the response based on the `refundAmount`\ \ field. \n" - name: status in: query type: string required: false description: "This parameter filters the response based on the `status` field.\ \ \n" enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress - name: targetDate in: query type: string format: date required: false description: "This parameter filters the response based on the `targetDate`\ \ field. \n" - name: taxAmount in: query type: number format: double required: false description: "This parameter filters the response based on the `taxAmount`\ \ field. \n" - name: totalTaxExemptAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `totalTaxExemptAmount` field. ' - name: transferredToAccounting in: query type: string required: false description: "This parameter filters the response based on the `transferredToAccounting`\ \ field. \n" enum: - Processing - 'Yes' - 'No' - Error - Ignore - name: unappliedAmount in: query type: number format: double required: false description: "This parameter filters the response based on the `unappliedAmount`\ \ field. \n" - name: updatedById in: query type: string required: false description: "This parameter filters the response based on the `updatedById`\ \ field. \n" - name: updatedDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `updatedDate` field. ' - name: sort in: query type: string required: false description: "This parameter restricts the order of the data returned in the\ \ response. You can use this parameter to supply a dimension you want to\ \ sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\ \nYou can use at most two sortable fields in one URL path. Use a comma to\ \ separate sortable fields. For example: *operator* *field_name*, *operator*\ \ *field_name* \n\n*operator* is used to mark the order of sequencing.\ \ The operator is optional. If you only specify the sortable field without\ \ any operator, the response data is sorted in descending order by this\ \ field.\n\n - The `-` operator indicates an ascending order.\n - The\ \ `+` operator indicates a descending order.\n\nBy default, the response\ \ data is displayed in descending order by credit memo number.\n\n*field_name*\ \ indicates the name of a sortable field. The supported sortable fields\ \ of this operation are as below:\n\n - accountId\n - amount\n - appliedAmount\n\ \ - createdById\n - createdDate\n - creditMemoDate\n - number\n - referredInvoiceId\n\ \ - refundAmount\n - status\n - targetDate\n - taxAmount\n - totalTaxExemptAmount\n\ \ - transferredToAccounting\n - unappliedAmount\n - updatedDate\n\n \ \ \nExamples:\n\n- /v1/creditmemos?sort=+number\n\n- /v1/creditmemos?status=Processed&sort=-number,+amount\n" /v1/creditmemos/bulk: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nCreates multiple credit memos from invoices or\ \ product rate plan charges. You can create a maximum of 50 credit memos in\ \ one single request. \n\n- If you set the `sourceType` request field to `Invoice`,\ \ you can create multiple credit memos from invoices.\n- If you set the `sourceType`\ \ request field to `Standalone`, you can create multiple credit memos from\ \ product rate plan charges.\n\nThe credit memos that are created are each\ \ in separate database transactions. If the creation of one credit memo fails,\ \ other credit memos can still be created successfully. \n\nYou can create\ \ credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nZero-amount memo items are supported in the following\ \ scenarios:\n- If you want to correct taxation items only for an invoice,\ \ you can set the memo item amount to zero, but the taxation item amount to\ \ non-zero.\n- If you want to correct personal data in an invoice, you can\ \ set the memo item amount to zero to create a zero-amount credit memo from\ \ an invoice.\n" summary: Create credit memos operationId: POST_CreateCreditMemos tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true memos: - id: ff8080817fe9d7b9017fe9e5382f04f5 number: CM00000001 accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 currency: USD creditMemoDate: '2022-04-02' targetDate: null postedById: null postedOn: null status: Draft amount: 100 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 100 refundAmount: 0 appliedAmount: 0 comment: test source: AdhocFromInvoice sourceId: null referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 reasonCode: Correcting invoice error createdDate: '2022-04-02 18:49:47' createdById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' updatedById: ff8080817fe9d7b9017fe9e41732030e cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: null sourceType: Invoice taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true - success: false processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. objectIndex: 1 schema: $ref: '#/definitions/BulkCreditMemosResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTBulkCreditMemosRequestType' put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\n Updates the basic and finance information about\ \ multiple credit memos. You can update a maximum of 50 credit memos in one\ \ single request.\n \n The credit memos that are updated are each in separate\ \ database transactions. If the update of one credit memo fails, other credit\ \ memos can still be updated successfully. \n \n Currently, Zuora supports\ \ updating tax-exclusive memo items, but does not support updating tax-inclusive\ \ memo items.\n\n If the amount of a memo item is updated, the tax will be\ \ recalculated in the following conditions:\n - The memo is created from\ \ a product rate plan charge and you use Avalara to calculate the tax.\n \ \ - The memo is created from an invoice and you use Avalara or Zuora Tax to\ \ calculate the tax.\n\n You can update credit memos only if you have the\ \ user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Update credit memos operationId: PUT_UpdateCreditMemos tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true memos: - id: ff8080817fe9d7b9017fe9e5382f04f5 number: CM00000001 accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 currency: USD creditMemoDate: '2022-04-02' targetDate: null postedById: null postedOn: null status: Draft amount: 100 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 100 refundAmount: 0 appliedAmount: 0 comment: test source: AdhocFromInvoice sourceId: null referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 reasonCode: Correcting invoice error createdDate: '2022-04-02 18:49:47' createdById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' updatedById: ff8080817fe9d7b9017fe9e41732030e cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: null sourceType: Invoice taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true - success: false id: ff8080817fe9d7b9017fe9e41732030f processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id. objectIndex: 1 schema: $ref: '#/definitions/BulkCreditMemosResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. - name: body in: body description: '' required: true schema: $ref: '#/definitions/PUTBulkCreditMemosRequestType' /v1/invoices/{invoiceKey}/creditmemos: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCreates an ad-hoc credit memo from an invoice.\n\ \nYou can create a credit memo from an invoice only if you have the user permission.\ \ See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nFor a use case of this operation, see [Create credit\ \ memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo).\n\ \nZero-amount memo items are supported in the following scenarios:\n- If you\ \ want to correct taxation items only for an invoice, you can set the memo\ \ item amount to zero, but the taxation item amount to non-zero.\n- If you\ \ want to correct personal data in an invoice, you can set the memo item amount\ \ to zero to create a zero-amount credit memo from an invoice.\n" summary: Create a credit memo from an invoice operationId: POST_CreditMemoFromInvoice tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a87d7f5015a88bd27f80014 number: CM00000013 accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: A00000001 currency: USD creditMemoDate: '2017-11-30' targetDate: null postedById: null postedOn: null status: Draft amount: 0.01 taxAmount: 0.01 totalTaxExemptAmount: 0 unappliedAmount: 0.01 refundAmount: 0 appliedAmount: 0 comment: the comment source: AdhocFromInvoice sourceType: Invoice sourceId: null referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 reasonCode: Write-off reversed: false createdDate: '2017-03-01 15:19:42' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:19:42' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: null excludeItemBillingFromRevenueAccounting: true transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `items` > `comment`\n\ * `items` > `description`\n" - name: body in: body description: '' required: true schema: $ref: '#/definitions/CreditMemoFromInvoiceType' - type: string in: path description: 'The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. ' name: invoiceKey required: true /v1/creditmemos/{creditMemoKey}: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about a specific credit\ \ memo.\n\nFor a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).\n" summary: Retrieve a credit memo operationId: GET_CreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a7e9791015a879f064a0054 number: CM00000012 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-01' targetDate: null postedById: null postedOn: null status: Draft amount: 3.1 taxAmount: 0.1 totalTaxExemptAmount: 0 unappliedAmount: 3.1 refundAmount: 0 appliedAmount: 0 comment: '' source: API sourceType: Standalone sourceId: null referredInvoiceId: 402890555a7e9791015a7f1756aa0035 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 402890555a7e9791015a879f07fb005e transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' name: creditMemoKey required: true put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUpdates the basic and finance information about\ \ a credit memo. Currently, Zuora supports updating tax-exclusive memo items,\ \ but does not support updating tax-inclusive memo items. \n\nIf the amount\ \ of a memo item is updated, the tax will be recalculated in the following\ \ conditions:\n - The memo is created from a product rate plan charge and\ \ you use Avalara to calculate the tax.\n - The memo is created from an invoice\ \ and you use Avalara or Zuora Tax to calculate the tax.\n\nYou can update\ \ a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Update a credit memo operationId: PUT_UpdateCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028905f5a890526015a8d73f73d0015 number: CM00000001 accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-02' targetDate: null postedById: null postedOn: null status: Draft amount: 10.76 taxAmount: 0.76 totalTaxExemptAmount: 0 unappliedAmount: 10.76 refundAmount: 0 appliedAmount: 0 comment: '' source: AdhocFromPrpc sourceId: null sourceType: Standalone referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-02 13:17:51' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:19:00' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 4028905f5a890526015a8d7408730024 transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body description: '' required: true schema: $ref: '#/definitions/PUTCreditMemoType' - type: string in: path description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' name: creditMemoKey required: true delete: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nDeletes a credit memo. Only credit memos with\ \ the Cancelled status can be deleted. \n\nYou can delete a credit memo only\ \ if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Delete a credit memo operationId: DELETE_CreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true /v1/creditmemos/{creditMemoKey}/apply: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nApplies a posted credit memo to one or more invoices\ \ and debit memos. \n\nYou can apply a credit memo to an invoice or a debit\ \ memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nWhen you apply a credit memo, the total number\ \ of credit memo items and the items that credit memo items to be applied\ \ to must be less than or equal to 15,000.\n\nIf the limit is hit, you can\ \ follow the following instructions:\n\n- If you want to apply one credit\ \ memo to multiple invoices or debit memos, decrease the number of invoices\ \ or debit memos in the request.\n- If you want to apply one credit memo to\ \ a single invoice or debit memo with a large volume of items, you have to\ \ specify invoice items or debit memo items in the request. The maximum number\ \ of invoice items or debit memo items that you can specify in the request\ \ is 1,000.\n- If a credit memo has a large volume of items, you have to specify\ \ credit memo items in the request. The maximum number of credit memo items\ \ that you can specify in the request is 1,000.\n \nIf the Proration\ \ application rule is used, when applying credit memos, the following quantity\ \ must be less than or equal to 15,000: \n\n(number of invoice items + number\ \ of debit memo items) * number of credit memo items\n\nOtherwise, the First\ \ In First Out rule will be used instead of the Proration rule.\n" summary: Apply a credit memo operationId: PUT_ApplyCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028905f5a890526015a8d73f73d0015 number: CM00000001 accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-02' targetDate: null postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-02 13:21:55' status: Posted amount: 10.76 taxAmount: 0.76 totalTaxExemptAmount: 0 unappliedAmount: 2.66 refundAmount: 7.1 appliedAmount: 1 comment: '' source: AdhocFromPrpc sourceId: null sourceType: Standalone referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-02 13:17:51' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:25:29' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 4028905f5a890526015a8d77af600036 transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body required: true schema: $ref: '#/definitions/ApplyCreditMemoType' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true /v1/creditmemos/{creditMemoKey}/cancel: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCancels a credit memo. Only credit memos with\ \ the Draft status can be cancelled. \n\nYou can cancel a credit memo only\ \ if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Cancel a credit memo operationId: PUT_CancelCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a87d7f5015a88c7a6830022 number: CM00000015 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 currency: USD creditMemoDate: '2017-10-17' targetDate: null postedById: null postedOn: null status: Canceled amount: 2020 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 2020 refundAmount: 0 appliedAmount: 0 comment: the comment source: AdhocFromPrpc sourceId: null sourceType: Standalone referredInvoiceId: null reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-01 15:31:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:36:57' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: '2017-09-03 19:59:07' cancelledById: 402881e522cf4f9b0122cf5d82860002 latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' name: creditMemoKey required: true /v1/creditmemos/{creditMemoKey}/emails: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nSends a posted credit memo to the specified email\ \ addresses manually.\n\n\n\n### Notes\n - You must activate the **Email\ \ Credit Memo | Manually email Credit Memo** notification before emailing\ \ credit memos. To include the credit memo PDF in the email, select the **Include\ \ Credit Memo PDF** check box in the **Edit notification** dialog from the\ \ Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2)\ \ for more information.\n\n\n - Zuora sends the email messages based on the\ \ email template you set. You can set the email template to use in the **Delivery\ \ Options** panel of the **Edit notification** dialog from the Zuora UI. By\ \ default, the **Manual Email for Credit Memo Default Template** template\ \ is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)\ \ for more information.\n\n\n - The credit memos are sent only to the work\ \ email addresses or personal email addresses of the Bill To contact if the\ \ following conditions are all met:\n\n * The `useEmailTemplateSetting`\ \ field is set to `false`.\n * The email addresses are not specified in\ \ the `emailAddresses` field.\n" summary: Email a credit memo operationId: POST_EmailCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body required: true description: '' schema: $ref: '#/definitions/PostCreditMemoEmailRequestType' - name: creditMemoKey type: string in: path required: true description: 'The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' /v1/creditmemos/{creditMemoKey}/files: post: summary: Upload a file for a credit memo operationId: POST_UploadFileForCreditMemo description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUploads an externally generated PDF file for a\ \ credit memo that is in Draft or Posted status.\n\nTo use this operation,\ \ you must enable the Modify Modify Credit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nThis operation has the following restrictions:\n\ - Only the PDF file format is supported.\n- The maximum size of the PDF file\ \ to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one\ \ credit memo.\n" consumes: - multipart/form-data tags: - Credit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: creditMemoKey in: path description: 'The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001. ' required: true type: string - name: file in: formData description: 'The PDF file to upload for the credit memo. ' type: file responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true fileId: 40289f466463d683016463ef8b7301a4 description: '' schema: $ref: '#/definitions/POSTUploadFileResponse' x-code-samples: - lang: curl label: Curl source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/creditmemos/402890555a7e9791015a879f064a0054/files" ' /v1/creditmemos/{creditMemoKey}/items: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about all items of a\ \ credit memo. A credit memo item is a single line item in a credit memo.\ \ \n\n### Filtering\n\nYou can use query parameters to restrict the data returned\ \ in the response. Each query parameter corresponds to one field in the response\ \ body.\n\nIf the value of a filterable field is string, you can set the corresponding\ \ query parameter to `null` when filtering. Then, you can get the response\ \ data with this field value being `null`. \n\nExamples:\n \n - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100\n\ \ \n - /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n\ \ \n" summary: List credit memo items operationId: GET_CreditMemoItems tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: items: - id: 402890555a7e9791015a879f064d0055 amount: 1 amountWithoutTax: 0 appliedAmount: 0 appliedToItemId: null refundAmount: 0 unappliedAmount: 1 comment: '' taxMode: TaxExclusive processingType: Charge quantity: 1 sku: SKU-00000001 skuName: New Component serviceStartDate: '2017-02-27' serviceEndDate: '2017-03-26' sourceItemType: InvoiceDetail sourceItemId: 402890555a7e9791015a7f1756bc0037 creditFromItemSource: CreditMemoItem creditFromItemId: 402880e97a56f30b017a574012e50085 excludeItemBillingFromRevenueAccounting: true createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' updatedById: 402881e522cf4f9b0122cf5d82860002 subscriptionId: 402890d25bec1155015bec35cc7c0bc7 unitOfMeasure: Each unitPrice: 1 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null taxationItems: data: - id: 402890555a7e9791015a87a072880062 sourceTaxItemId: null taxAmount: 0.1 appliedAmount: 0 unappliedAmount: 0.1 refundAmount: 0 name: STATE TAX exemptAmount: 0 jurisdiction: CALIFORNIA locationCode: '06' taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash - id: 402890555a7e9791015a879f06610056 amount: 2 amountWithoutTax: 2 appliedAmount: 0 appliedToItemId: null refundAmount: 0 unappliedAmount: 2 comment: '' taxMode: TaxExclusive processingType: Charge quantity: 1 sku: SKU-00000001 skuName: New Component serviceStartDate: '2017-02-27' serviceEndDate: '2017-03-26' sourceItemType: InvoiceDetail sourceItemId: 402890555a7e9791015a7f1756bd0038 excludeItemBillingFromRevenueAccounting: true creditFromItemSource: CreditMemoItem creditFromItemId: 402880e97a56f30b017a574012f00086 createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:07:10' updatedById: 402881e522cf4f9b0122cf5d82860002 subscriptionId: 402890d25bec1155015bec35cc7c0bc7 unitOfMeasure: Each unitPrice: 2 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null taxationItems: data: [] success: true schema: $ref: '#/definitions/GETCreditMemoItemsListType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following response fields:\n* `items` > `creditTaxItems`\n\ * `items` > `taxationItems`\n* `items` > `comment`\n* `items` > `description`\n" - name: amount in: query type: number format: double required: false description: "This parameter filters the response based on the `amount` field.\ \ \n" - name: appliedAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `appliedAmount` field. ' - name: createdById in: query type: string required: false description: "This parameter filters the response based on the `createdById`\ \ field. \n" - name: createdDate in: query type: string format: date-time required: false description: "This parameter filters the response based on the `createdDate`\ \ field. \n" - name: id in: query type: string required: false description: "This parameter filters the response based on the `id` field.\ \ \n" - name: refundAmount in: query type: number format: double required: false description: "This parameter filters the response based on the `refundAmount`\ \ field. \n" - name: serviceEndDate in: query type: string format: date required: false description: "This parameter filters the response based on the `serviceEndDate`\ \ field. \n" - name: serviceStartDate in: query type: string format: date required: false description: "This parameter filters the response based on the `serviceStartDate`\ \ field. \n" - name: sku in: query type: string required: false description: "This parameter filters the response based on the `sku` field.\ \ \n" - name: skuName in: query type: string required: false description: "This parameter filters the response based on the `skuName` field.\ \ \n" - name: sourceItemId in: query type: string required: false description: "This parameter filters the response based on the `sourceItemId`\ \ field. \n" - name: subscriptionId in: query type: string required: false description: 'This parameter filters the response based on the `subscriptionId` field. ' - name: updatedById in: query type: string required: false description: "This parameter filters the response based on the `updatedById`\ \ field. \n" - name: updatedDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `updatedDate` field. ' - name: sort in: query type: string required: false description: "This parameter restricts the order of the data returned in the\ \ response. You can use this parameter to supply a dimension you want to\ \ sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\ \nYou can use at most two sortable fields in one URL path. Use a comma to\ \ separate sortable fields. For example: *operator* *field_name*, *operator*\ \ *field_name* \n\n*operator* is used to mark the order of sequencing.\ \ The operator is optional. If you only specify the sortable field without\ \ any operator, the response data is sorted in descending order by this\ \ field.\n\n - The `-` operator indicates an ascending order.\n - The\ \ `+` operator indicates a descending order.\n\nBy default, the response\ \ data is displayed in descending order by updated date.\n\n*field_name*\ \ indicates the name of a sortable field. The supported sortable fields\ \ of this operation are as below:\n\n - amount\n - appliedAmount\n -\ \ createdById\n - createdDate\n - id\n - refundAmount\n - serviceEndDate\n\ \ - serviceStartDate\n - sku\n - skuName\n - sourceItemId\n - subscriptionId\n\ \ - updatedById\n - updatedDate\n \nExamples:\n\n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate\n\ \n- /v1/creditmemos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n" /v1/creditmemos/{creditMemoKey}/items/{cmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo. summary: Retrieve a credit memo item operationId: GET_CreditMemoItem tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a7e9791015a879f064d0055 amount: 1 amountWithoutTax: 1 appliedAmount: 0 appliedToItemId: null refundAmount: 0 unappliedAmount: 1 comment: '' taxMode: TaxExclusive processingType: Charge quantity: 1 sku: SKU-00000001 skuName: New Component serviceStartDate: '2017-02-27' serviceEndDate: '2017-03-26' sourceItemType: InvoiceDetail sourceItemId: 402890555a7e9791015a7f1756bc0037 creditFromItemSource: CreditMemoItem creditFromItemId: 402880e97a56f30b017a574012f00086 createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' updatedById: 402881e522cf4f9b0122cf5d82860002 excludeItemBillingFromRevenueAccounting: true subscriptionId: 402890d25bec1155015bec35cc7c0bc7 unitOfMeasure: Each unitPrice: 1 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null taxationItems: data: [] success: true schema: $ref: '#/definitions/GETCreditMemoItemType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: cmitemid description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). ' required: true - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following response fields:\n* `creditTaxItems`\n\ * `taxationItems`\n* `comment`\n* `description`\n" /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nRetrieves information about the taxation items\ \ of a specific credit memo item. \n" summary: List all taxation items of a credit memo item operationId: GET_TaxationItemsOfCreditMemoItem tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: "A custom identifier for tracing the API call. If you specified\ \ a tracing identifier in the request headers, Zuora returns the same\ \ tracing identifier. Otherwise, Zuora does not set this header. \ \ \n" description: '' examples: application/json: data: - sourceTaxItemId: null appliedAmount: 0 unappliedAmount: 10 refundAmount: 0 financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 2c98901a68ff2680016903216a271a67 taxAmount: 10 name: taxName_0 exemptAmount: 10 jurisdiction: Jurisdiction locationCode: '8' taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage success: true schema: $ref: '#/definitions/GETTaxationItemsOfCreditMemoItemType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/parameters/GLOBAL_REQUEST_page' - type: string in: path name: cmitemid description: 'The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo items](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoItems). ' required: true - type: string in: path name: creditMemoId description: 'The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true /v1/creditmemos/{creditMemoKey}/parts: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about all parts of a\ \ credit memo. A credit memo can consist of an unapplied part, and several\ \ parts applied to invoices and debit memos. You can use this operation to\ \ get all the applied and unapplied portions of a credit memo. Note that a\ \ fully refunded credit memo does not contain any credit memo part.\n" summary: List all parts of a credit memo operationId: GET_CreditMemoParts tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: parts: - id: 4028905f5a890526015a8d77adea0029 invoiceId: null debitMemoId: null amount: 3.66 createdDate: '2017-03-02 13:21:55' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:21:55' updatedById: 402881e522cf4f9b0122cf5d82860002 success: true schema: $ref: '#/definitions/GETCreditMemoPartsCollectionType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true /v1/creditmemos/{creditMemoKey}/parts/{partid}: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about a specific credit\ \ memo part. A credit memo can consist of an unapplied part, and several parts\ \ applied to invoices and debit memos.\n\nA fully refunded credit memo does\ \ not contain any credit memo part.\n" summary: Retrieve a credit memo part operationId: GET_CreditMemoPart tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028905f5a890526015a8d9adeb30059 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 debitMemoId: null amount: 1 createdDate: '2017-03-02 14:00:21' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 14:00:21' updatedById: 402881e522cf4f9b0122cf5d82860002 success: true schema: $ref: '#/definitions/GETCreditMemoPartType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: partid description: 'The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit memo](https://developer.zuora.com/api-references/api/operation/GET_CreditMemoParts). ' required: true - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true /v1/creditmemos/{creditMemoKey}/pdfs: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCreates a PDF file for a specified credit memo.\ \ To access the generated PDF file, you can download it by clicking **View\ \ PDF** on the detailed credit memo page through the Zuora UI.\n\nThis REST\ \ API operation can be used only if you have the billing document file generation\ \ feature and the Billing user permission \"Regenerate PDF\" enabled.\n" summary: Generate a credit memo PDF file operationId: POST_CreditMemoPDF parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: creditMemoKey in: path description: 'The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true type: string tags: - Credit Memos responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/POSTMemoPdfResponse' /v1/creditmemos/{creditMemoKey}/post: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nPosts a credit memo to activate it. You can post\ \ credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n" summary: Post a credit memo operationId: PUT_PostCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a7e9791015a879f064a0054 number: CM00000012 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-01' targetDate: null postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' status: Posted amount: 3.1 taxAmount: 0.1 totalTaxExemptAmount: 0 unappliedAmount: 3.1 refundAmount: 0 appliedAmount: 0 comment: '' source: API sourceId: null sourceType: Standalone referredInvoiceId: 402890555a7e9791015a7f1756aa0035 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true /v1/creditmemos/{creditMemoKey}/refunds: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRefunds a full or partial posted credit memo to\ \ your customers. Only the amount of unapplied part could be refunded. \n\n\ You can refund a credit memo only if you have the user permission. See [Billing\ \ Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nWhen you refund a credit memo, the total number\ \ of credit memo items to be refunded must be less than or equal to 15,000.\n\ \nFor a use case of this operation, see [Refund processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing).\n" summary: Refund a credit memo operationId: POST_RefundCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028905f5a890526015a8d7af4280039 number: R-00000002 status: Processed type: External methodType: CreditCard accountId: 4028905f5a87c0ff015a87d25ae90025 amount: 7.1 refundDate: '2017-03-02' comment: null paymentMethodId: null paymentMethodSnapshotId: null paymentId: null creditMemoId: 4028905f5a890526015a8d73f73d0015 reasonCode: Standard Refund gatewayId: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted markedForSubmissionOn: null referenceId: null secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: null settledOn: null cancelledOn: null createdDate: '2017-03-02 13:25:29' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:25:29' updatedById: 402881e522cf4f9b0122cf5d82860002 refundTransactionTime: null financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null transferredToAccounting: 'No' success: true schema: $ref: '#/definitions/GETRefundCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body required: true schema: $ref: '#/definitions/PostNonRefRefundType' - type: string in: path name: creditMemoKey description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. ' required: true /v1/creditmemos/{creditMemoKey}/reverse: put: summary: Reverse a credit memo operationId: PUT_ReverseCreditMemo description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Reverses a posted credit memo. See [Reverse credit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/C_Management_of_Credit_and_Debit_Memos/Reverse_credit_memos) for more information. You can reverse a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. **Restrictions** You cannot reverse credit memos if any of the following conditions is met: * A credit memo's applied amount is not 0. * A credit memo is not in Posted status. * A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items. tags: - Credit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: creditMemoKey in: path required: true type: string description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. ' - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PutReverseCreditMemoType' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: debitMemo: id: 402890555a40ca7f015a5b099b0e307a success: true description: '' schema: $ref: '#/definitions/PutReverseCreditMemoResponseType' /v1/creditmemos/{creditMemoKey}/taxationitems: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a credit memo. summary: Create taxation items for a credit memo operationId: POST_CM_TaxationItems tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:08:43' exemptAmount: 0 id: 402890555a7e9791015a87a072880062 memoItemId: 402890555a7e9791015a879f064d0055 sourceTaxItemId: 402890555a7d4022015a7db254e200c1 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash success: true schema: $ref: '#/definitions/GETTaxationItemListType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: creditMemoKey required: true description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTTaxationItemListForCMType' /v1/creditmemos/{creditMemoKey}/unapply: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nUnapplies an applied credit memo from one or more\ \ invoices and debit memos. The full applied amount from invoices and debit\ \ memos is transferred into the unapplied amount of the credit memo. \n\n\ You can unapply a credit memo from an invoice or a debit memo only if you\ \ have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nWhen you unapply a credit memo, the total number\ \ of credit memo items and the items that credit memo items to be unapplied\ \ from must be less than or equal to 15,000.\n\nIf the limit is hit, you can\ \ follow the following instructions:\n\n- If you want to unapply one credit\ \ memo without specifying invoices or debit memos and the limit is hit, you\ \ have to specify the invoice items or debit memo items in the request to\ \ decrease the number of items.\n- If you want to unapply one credit memo\ \ from multiple specified invoices or debit memos, decrease the number of\ \ invoices or debit memos in the request.\n- If you want to unapply one credit\ \ memo from a single invoice or debit memo with a large volume of items, you\ \ have to specify invoice items or debit memo items in the request. The maximum\ \ number of invoice items or debit memo items that you can specify in the\ \ request is 1,000.\n- If a credit memo has a large volume of items, you have\ \ to specify credit memo items in the request. The maximum number of credit\ \ memo items that you can specify in the request is 1,000.\n\n\nIf the Proration\ \ application rule is used, when unapplying credit memos, the following quantity\ \ must be less than or equal to 15,000: \n\n(number of invoice items + number\ \ of debit memo items) * number of credit memo items\n\nOtherwise, the First\ \ In First Out rule will be used instead of the Proration rule.\n" summary: Unapply a credit memo operationId: PUT_UnapplyCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028905f5a890526015a8d73f73d0015 number: CM00000001 accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-02' targetDate: null postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-02 13:21:55' status: Posted amount: 10.76 taxAmount: 0.76 sourceType: Standalone totalTaxExemptAmount: 0 unappliedAmount: 3.66 refundAmount: 7.1 appliedAmount: 0 comment: '' source: AdhocFromPrpc sourceId: null referredInvoiceId: 4028905f5a87c0ff015a87d3f8f10043 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-02 13:17:51' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:25:29' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 4028905f5a890526015a8d77af600036 transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body required: true schema: $ref: '#/definitions/UnapplyCreditMemoType' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true /v1/creditmemos/{creditMemoKey}/unpost: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUnposts a credit memo that is in Posted status.\ \ If a credit memo has been applied or refunded, you are not allowed to unpost\ \ it. After a credit memo is unposted, its status becomes Draft. \n\nYou can\ \ unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n" summary: Unpost a credit memo operationId: PUT_UnpostCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a7e9791015a879f064a0054 number: CM00000012 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 currency: USD creditMemoDate: '2017-03-01' targetDate: null postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' status: Draft amount: 3.1 taxAmount: 0.1 totalTaxExemptAmount: 0 unappliedAmount: 3.1 refundAmount: 0 appliedAmount: 0 comment: '' source: API sourceId: null sourceType: Standalone referredInvoiceId: 402890555a7e9791015a7f1756aa0035 reasonCode: Correcting invoice error reversed: false createdDate: '2017-03-01 10:07:10' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETCreditMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: creditMemoKey description: 'The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. ' required: true /v1/creditmemos/{creditMemoId}/write-off: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nWrite off a fully unapplied credit memo. When\ \ writing off a credit memo, a debit memo is automatically created, and then\ \ the credit memo to be written off is fully applied to the debit memo.\n\n\ Note that this operation only supports writing off credit memos that are fully\ \ unapplied. Credit memos that are not fully unapplied cannot be written off\ \ by this operation. \n" summary: Write off a credit memo operationId: PUT_WriteOffCreditMemo tags: - Credit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: debitMemo: id: 4028905f5a87c0ff015a87e49e6b0062 success: true schema: $ref: '#/definitions/PUTCreditMemoWriteOffResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: creditMemoId description: 'The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. ' required: true - name: Request in: body description: '' required: true schema: $ref: '#/definitions/PUTCreditMemoWriteOff' /v1/creditmemos/{creditMemoKey}/einvoice/generate: put: summary: Generate an e-invoice file for a credit memo operationId: PUT_GenerateEInvoiceFileForCreditMemo description: | Generates an e-invoice file for a credit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. tags: - Credit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: creditMemoKey in: path required: true type: string description: 'The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /events/event-triggers: post: tags: - Custom Event Triggers operationId: POST_EventTrigger summary: Create an event trigger description: "When you create an event trigger, you must specify the base object\ \ and define the trigger condition.\n\n### Specify the base object\nUse `baseObject`\ \ field to specify which object to define a trigger on. You can define an\ \ event trigger on any of the following objects:\n\n * Account\n * AccountingCode\n\ \ * AccountingPeriod\n * Amendment\n * BillingRun\n * Contact\n * CreditBalanceAdjustment\n\ \ * CreditMemo\n * CreditMemoApplication\n * CreditMemoApplicationItem\n\ \ * CreditMemoItem\n * DebitMemo\n * DebitMemoItem\n * Feature\n * Invoice\n\ \ * InvoiceAdjustment\n * InvoiceItem\n * InvoiceItemAdjustment\n * JournalEntry\n\ \ * JournalEntryItem\n * Order\n * OrderAction\n * OrderLineItem\n *\ \ Payment\n * PaymentApplication\n * PaymentMethod\n * PaymentPart\n *\ \ PaymentSchedule\n * PaymentScheduleItem\n * PrepaidValidityPeriodSummary\n\ \ * Product\n * ProductFeature\n * ProductRatePlan\n * ProductRatePlanCharge\n\ \ * ProductRatePlanChargeTier\n * RatePlan\n * RatePlanCharge\n * RatePlanChargeTier\n\ \ * Refund\n * RefundApplication\n * RevenueEvent\n * RevenueEventItem\n\ \ * RevenueSchedule\n * RevenueScheduleItem\n * Subscription\n * SubscriptionProductFeature\n\ \ * TaxationItem\n * UpdaterDetail\n * Usage\n\nIn addition to the above\ \ Zuora standard objects, you can also use custom objects as base objects\ \ for custom events.\n\n#### Tenant level base objects and tenant level event\ \ triggers\nZuora identifies the following base objects and custom objects\ \ as the tenant level base objects:\n\n * AccountingCode\n * AccountingPeriod\n\ \ * BillingRun\n * Feature\n * JournalEntry\n * JournalEntryItem\n *\ \ Product\n * ProductFeature\n * ProductRatePlan\n * ProductRatePlanCharge\n\ \ * ProductRatePlanChargeTier\n\nEvent triggers defined on tenant level base\ \ objects are tenant level event triggers. Notifications associated with tenant\ \ level events are system notifications. \n\n**Note:** Tenant level event\ \ triggers and system notifications are only available in the default profile.\ \ \n\n### Define the trigger condition\nThe `condition` field is a\ \ [JEXL](http://commons.apache.org/proper/commons-jexl/) expression that specifies\ \ when to trigger events. The expression can contain fields from the object\ \ that the trigger is defined on.\n\n**Note:** The condition cannot contain\ \ fields from [data source](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL)\ \ objects that are joined to the object that the trigger is defined on.\n\n\ For example, the following condition causes an event to be triggered whenever\ \ an invoice is posted with an amount greater than 1000:\n\n```changeType\ \ == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted'\ \ && Invoice.Amount > 1000```\n\nWhere:\n\n * `changeType` is a keyword that\ \ specifies the type of change that occurred to the Invoice object. For all\ \ objects, the supported values of `changeType` are `INSERT`, `UPDATE`, and\ \ `DELETE`.\n * `Invoice.Status` is the value of the Invoice object's `Status`\ \ field after the change occurred.\n * `Invoice.Status_old` is the value\ \ of the Invoice object's `Status` field before the change occurred.\n\nIn\ \ the above example, the value of `baseObject` is `Invoice`.\n\n#### Limitations\ \ \n\nThis event trigger has the following limitations:\n\n* Base object values\ \ for Zuora standard objects are case sensitive. For example, `PaymentMethod`\ \ is correct, and `Paymentmethod` or `paymentmethod` is incorrect.\n\n* Base\ \ object values for custom objects must be lowercase. For example, `default__vehicle`.\n\ \n* The INSERT change type is not supported on RatePlan base objects.\n\n\ * The INSERT change type is not supported on SubscriptionProductFeature base\ \ objects.\n\n* When creating custom events, you cannot match fields of the\ \ RatePlanCharge object against constant values for the `condition` field.\ \ For example, the following condition will cause errors: `RatePlanCharge.ShippingProcessStatus__c\ \ == 'Shipping Confirmed'`, where `Shipping Confirmed` is a constant value.\n\ \n* Fields on objects are case-sensitive. For example, `PaymentMethod.createdbyid`\ \ can result in errors. The correct format is `PaymentMethod.CreatedById`.\ \ \n\n* A condition cannot contain fields from data source objects that are\ \ joined to the base object.\n\n* Do not create duplicate events because they\ \ will be either merged or deleted. Zuora considers events that have the same\ \ trigger condition as duplicate events, regardless of event type names. \n\ \nSee [Custom Events](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Z_Custom_Events)\ \ for more information. \n" 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: postEventTriggerRequest in: body required: true schema: $ref: '#/definitions/PostEventTriggerRequest' responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/EventTrigger' examples: application/json: |- { "id": "ac1ee535e8524858a72edb464212729d", "baseObject": "Invoice", "condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000", "description": "trigger an event when an invoice is posted with amount over 1000", "eventType": { "name": "LargeInvoicePosted", "displayName": "Large Invoice Posted", "description": "An invoice is posted with amount over 1000" }, "active": true } 400: description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "MissingRequiredField", "message": "eventType is missing" } ] } 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } get: tags: - Custom Event Triggers operationId: GET_EventTriggers summary: List event triggers parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: baseObject in: query description: | The Zuora object that trigger condition is defined upon. The format of the value in this field depends on the base object type: - Standard object: object name, which should follow the pattern ^[A-Z][\w\-]*$. For example, `Invoice`. - Custom object: `default__`. For example, `default__vehicle`. required: false type: string - name: eventTypeName in: query description: 'The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\w\-]*$' required: false type: string - name: active in: query description: The status of the event trigger. required: false type: string - name: start in: query description: The first index of the query result. Default to 0 if absent, and the minimum is 0. required: false type: integer default: 0 minimum: 0 - name: limit in: query description: The maximum number of data records to be returned. Default to 10 if absent. required: false type: integer default: 10 minimum: 1 responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: type: object properties: data: type: array items: $ref: '#/definitions/EventTrigger' next: type: string description: The link to the next page. No value if it is last page. examples: application/json: |- { "data": [ { "id": "ac1ee535e8524858a72edb464212729d", "baseObject": "Invoice", "condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000", "description": "trigger an event when an invoice is posted with amount over 1000", "eventType": { "name": "LargeInvoicePosted", "displayName": "Large Invoice Posted", "description": "An invoice is posted with amount over 1000" }, "active": true } ], "next": "https://api.zuora.com/events/event-triggers?start=1&limit=1" } 400: description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "FieldConstraintViolation", "message": "start should be >= 0" } ] } 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } /events/event-triggers/{id}: get: tags: - Custom Event Triggers operationId: GET_EventTrigger summary: Retrieve an event trigger parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path required: true type: string format: uuid responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/EventTrigger' examples: application/json: |- { "id": "ac1ee535e8524858a72edb464212729d", "baseObject": "Invoice", "condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000", "description": "trigger an event when an invoice is posted with amount over 1000", "eventType": { "name": "LargeInvoicePosted", "displayName": "Large Invoice Posted", "description": "An invoice is posted with amount over 1000" }, "active": true } 404: description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } put: description: '' tags: - Custom Event Triggers operationId: PUT_EventTrigger summary: Update an event trigger parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path required: true type: string format: uuid - name: putEventTriggerRequest in: body required: true schema: $ref: '#/definitions/PutEventTriggerRequest' responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/EventTrigger' examples: application/json: |- { "id": "ac1ee535e8524858a72edb464212729d", "baseObject": "Invoice", "condition": "changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 5000", "description": "trigger an event when an invoice is posted with amount over 5000", "eventType": { "name": "LargeInvoicePosted", "displayName": "Large Invoice Posted", "description": "An invoice is posted with amount over 5000" }, "active": true } 404: description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } delete: description: '' tags: - Custom Event Triggers operationId: DELETE_EventTrigger summary: Delete an event trigger parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path required: true type: string format: uuid responses: 204: description: No Content 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' 404: description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } /v1/custom-exchange-rates/{currency}: get: summary: List custom exchange rates by currency operationId: GET_CustomExchangeRates description: "This feature is in **Limited Availability**. If you wish to have\ \ access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\ \ \n\nThis reference describes how to query custom foreign exchange rates\ \ from Zuora. You can use this API method to query exchange rates only if\ \ you use a custom exchange rate provider and upload rates with the Import\ \ Foreign Exchange Rates mass action. \n" tags: - Custom Exchange Rates 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: currency in: path description: "The target base currency of the tenant. The exchange rates in\ \ the response are calculated in relation to the target currency.\n\nThe\ \ value must be a three-letter currency code, for example, USD. \n" required: true type: string - name: startDate in: query description: | Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-15. The start date cannot be later than the end date. required: true type: string - name: endDate in: query description: | End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-16. The end date can be a maximum of 90 days after the start date. required: true type: string responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true inverse: false rates: '2019-04-28': providerExchangeRateDate: '2019-04-28' GBP: 1.135239621 USD: 0.889028445 '2019-04-29': providerExchangeRateDate: '2019-04-29' GBP: 1.134623962 USD: 0.892140244 '2019-04-30': providerExchangeRateDate: '2019-04-30' GBP: 1.134589832 USD: 0.892243287 description: '' schema: $ref: '#/definitions/GETCustomExchangeRatesType' x-code-samples: - lang: curl label: Curl source: 'curl -X GET -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.sandbox.eu.zuora.com/v1/custom-exchange-rates/EUR?startDate=2019-04-28&endDate=2019-04-30" ' /objects/definitions/default: get: summary: List custom object definitions description: 'Get all custom objects definitions for a given tenant. If you want to copy all the existing custom objects from an old tenant to a new tenant, you can call this operation in your old tenant and then use its response directly as the request of the [Create custom object definitions](https://developer.zuora.com/api-references/api/operation/POST_CustomObjectDefinitions) call in the new tenant to import all the custom objects from the old tenant. ' operationId: GET_AllCustomObjectDefinitionsInNamespace tags: - Custom Object Definitions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: select description: 'If you set `select` to `type`, the response will only contain the `type` of each custom object. ' in: query required: false type: string enum: - type responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GETAllCustomObjectDefinitionsInNamespaceResponse' post: summary: Create custom object definitions operationId: POST_CustomObjectDefinitions description: "You can post custom object definitions with the request body schema\ \ described below. \n\nThis operation also allows you to use the [List custom\ \ object definitions](https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace)\ \ response schema as its request schema. If you want to copy all the existing\ \ custom objects from an old tenant to a new tenant, you can make a [List\ \ custom object definitions](https://developer.zuora.com/api-references/api/operation/GET_AllCustomObjectDefinitionsInNamespace)\ \ call in your old tenant and then use its response directly as the request\ \ of this operation in the new tenant to import all the custom objects from\ \ the old tenant.\n\nThe `label` field is the UI label of the custom object.\ \ The `object` field contains the API Name of the custom object.\n\n### Limitations\ \ \n\nThis custom object definition has the following limitations:\n\n* The\ \ maximum number of characters for the Custom Object API Name (`object`) is\ \ 64.\n* The maximum number of characters for the Custom Object Label (`label`)\ \ is\t64.\n* The maximum number of characters for the Custom Object Description\ \ 250.\n* The maximum number of custom fields in an custom object\tis 50.\n\ * The maximum number of characters for the custom field API name is\t64.\n\ * The maximum number of characters for the custom field label (`label`) is\t\ 64.\n* The maximum number of characters for the custom field Description\t\ is 250.\n* The maximum number of picklist or multiselect options is 250.\n\ * The default maximum number of characters for the Text field is 512. You\ \ can configure the max length up to 8,192 characters when creating or updating\ \ the custom object definition via API.\n However, if the Text field is filterable,\ \ the max length must be 512 or less.\n* The maximum number of digits to the\ \ left of the decimal point for the Number field is 13, and to the right is\ \ 9.\n" tags: - Custom Object Definitions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: custom object definitions in: body required: true description: The custom object definitions to be created schema: $ref: '#/definitions/PostCustomObjectDefinitionsRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GETAllCustomObjectDefinitionsInNamespaceResponse' '400': description: Bad request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' /objects/definitions/default/{object}: get: summary: Retrieve a custom object definition description: 'Retrieves the custom object definition by type for the given tenant. ' operationId: GET_CustomObjectDefinitionByType tags: - Custom Object Definitions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectDefinition' '404': description: Resource Request-URI not found. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' delete: summary: Delete a custom object definition description: | Deletes the custom object definition for the provided type. **Note:** A custom object definition can only be deleted if no record of this custom object type exists. operationId: Delete_CustomObjectDefinitionByType tags: - Custom Object Definitions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: type: string description: The URI of the deleted custom object definition format: uri example: /objects/definitions/default/test_custom_object /objects/migrations: post: summary: Update a custom object definition operationId: POST_UpdateCustomObjectDefinition description: "Updates a custom object definition by posting migration resource\ \ to initiate the migration of definitions.\n\n### Limitations \n\nUpdating\ \ custom field definition has the following limitations:\n\n* You can only\ \ have one action per update request.\n* You cannot delete fields from custom\ \ objects that contain records.\n* You can only add required fields to custom\ \ objects with no records.\n* You can change optional fields to required only\ \ on the custom objects with no records. \n" tags: - Custom Object Definitions parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: migration in: body required: true description: Migration resource for object and namespace changes. schema: $ref: '#/definitions/MigrationUpdateCustomObjectDefinitionsRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/MigrationUpdateCustomObjectDefinitionsResponse' /objects/records/default/{object}: post: summary: Create custom object records operationId: POST_CustomObjectRecords description: "Creates custom object records with the given type. \n\nUpon creating\ \ records of a custom object type, the 200 response contains a list of records\ \ that have been successfully processed and stored.\n\n\n### Limitations \n\ \nThis call has the following limitations:\n* The maximum number of records\ \ that you can create by one call is 1,000.\n* The storage of empty strings\ \ in records is not supported.\n* Null values must be formatted as the following\ \ example: \n ```\n {\n \"records\": [\n {\n \"fieldName__c\"\ : null\n }\n ]\n }\n ```\n" tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: custom objects records in: body required: true schema: $ref: '#/definitions/PostCustomObjectRecordsRequest' responses: '200': description: | OK The 200 response indicates that the records have been partially or completely created. * If the `allowPartialSuccess` flag is set to `false`, the 200 response indicates that all object records have been successfully created. * If the `allowPartialSuccess` flag is set to `true`, the 200 response indicates that some records might not be succesffully created and the error information might be contained in the response body. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/PostCustomObjectRecordsResponse' '400': description: Failed schema validation 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordsErrorResponse' '401': description: Unauthorized 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse401Record' '500': description: Internal error. Retry the returned records. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordsThrottledResponse' get: summary: List records for a custom object description: | Lists all object records of the given type. You can also use the `q` query parameter to filter the output records. ### Custom Objects read consistency Custom Objects support eventually consistency. When you read custom object records, the response might not reflect the result of a recently completed operation and might include some stale data. The operations include creating, updating, and deleting custom object records. If you repeat your read request after a short time, the response should return the latest data. For example, if you create five records and perform a query that these five records satisfy the query conditions, there might be a delay before these records can be returned in the query result. operationId: GET_AllRecordsForCustomObjectType tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: q description: | The query string to filter the records of a custom object. See the [Query syntax of custom object records](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Data_Model/Custom_object_records/Query_syntax_of_custom_object_records) for more information. Note that the `q` parameter only applies to filterable fields. in: query required: false type: string - name: ids description: | UUIDs of the records to be queried. Each UUID must be a string of 36 characters. For example: `GET /objects/records/default/passenger?ids=258d65b2-7bc6-4142-88bc-5184931af493&ids=82ecc9f7-b192-4f88-a4a3-4b2af6c750a1` in: query required: false type: string - name: pageSize minimum: 1 maximum: 1000 description: The number of records returned per page in the response. in: query required: false type: integer - name: cursor description: The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid. in: query required: false type: string responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/QueryCustomObjectRecordsResponse' /objects/records/default/{object}/{id}: get: summary: Retrieve a custom object record description: 'Retrieves a record of a given type by ID. ' operationId: GET_CustomObjectRecordByID tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: id in: path required: true type: string minLength: 36 maxLength: 36 format: uuid description: Id identifier in uuid form responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordWithAllFields' '404': description: Not exist 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' put: summary: Update a custom object record description: "Updates a record of the given type and ID.\n\n### Limitations\ \ \n\n* The storage of empty strings in records is not supported.\n* Null\ \ values must be formatted as the following example: \n ```\n {\n \"\ records\": [\n {\n \"fieldName__c\": null\n }\n ]\n }\n\ \ ```\n" operationId: PUT_CustomObjectRecord tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_If_Match' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: id in: path required: true type: string minLength: 36 maxLength: 36 format: uuid description: Id identifier in uuid form - name: objectRecordRequest in: body required: true schema: $ref: '#/definitions/CustomObjectRecordWithOnlyCustomFields' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordWithAllFields' '404': description: Object record does not exist 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' patch: summary: Partially update a custom object record consumes: - application/merge-patch+json operationId: Patch_PartialUpdateCustomObjectRecord description: "Updates one or many fields of a custom object record. Patch update\ \ uses JSON Merge Patch as specified in [RFC 7386](https://tools.ietf.org/html/rfc7386).\n\ \n### Limitations \n\n* The storage of empty strings in records is not supported.\n\ * Null values must be formatted as the following example: \n ```\n {\n \ \ \"records\": [\n {\n \"fieldName__c\": null\n }\n \ \ ]\n }\n ```\n" tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: id in: path required: true type: string minLength: 36 maxLength: 36 format: uuid description: Id identifier in uuid form - name: objectRecordPatchRequest in: body required: true schema: $ref: '#/definitions/CustomObjectRecordWithOnlyCustomFields' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordWithAllFields' '404': description: Object record does not exist 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' delete: summary: Delete a custom object record description: "Deletes a custom object record of the given type and ID.\n\nNote\ \ that 200 response will be returned under either of the following conditions:\n\ * The record is identified and successfully deleted\n* The record could not\ \ be found\n\nNote that\_the record is deleted immediately and, therefore,\ \ will not be retained upon successful deletion.\n" operationId: Delete_CustomObjectRecordByID tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: id in: path required: true type: string minLength: 36 maxLength: 36 format: uuid description: Id identifier in uuid form responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: type: string description: The URI of the deleted custom object record. format: uri example: /objects/records/default/test_custom_object/3a437f0b-fa7a-45bf-a9a5-2187a5a13ec0 /objects/batch/default/{object}: post: summary: Update or delete custom object records operationId: POST_CustomObjectRecordsBatchUpdateOrDelete description: "Makes a batch update or delete of custom object records.\n###\ \ Limitations \n\nThis call has the following limitations:\n* The maximum\ \ number of records that you can update by one call is 1,000.\n* The maximum\ \ number of records that you can delete by one call is 1,000.\n* The storage\ \ of empty strings in records is not supported.\n* Null values must be formatted\ \ as the following example: \n ```\n {\n \"action\": {\n \"\ type\": \"update\",\n \"records\": {\n \"64edb2a5-2796-4e95-9559-846f8636a01b\"\ : {\n \"fieldName__c\": null\n }\n }\n\ \ }\n }\n ```\n" tags: - Custom Object Records parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: object in: path required: true type: string description: Specifies the custom object's API name as object. It is case-sensitive. - name: CustomObjectRecordBatchRequest in: body required: true schema: $ref: '#/definitions/CustomObjectRecordBatchRequest' responses: '200': description: | OK For the bacth `delete` action, it indicates the batch records have been successfully deleted. For the batch `update` action, it indicates that the batch records have been partially or completely updated. * If the `allowPartialSuccess` flag is set to `false`, the 200 response indicates that all object records have been successfully updated. * If the `allowPartialSuccess` flag is set to `true`, the 200 response indicates that some records might not be succesffully updated and the error information might be contained in the response body. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordsBatchUpdatePartialSuccessResponse' '400': description: | Failed schema validation For the batch `update` action, the 400 response only returns when the `allowPartialSuccess` flag is set to `false` and the batch records have failed schema validation. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordsErrorResponse' '401': description: Unauthorized 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse401Record' '500': description: Internal error. Retry the returned records. 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectRecordsThrottledResponse' /objects/jobs: post: summary: Submit a custom object bulk job description: "Submits a bulk job request for a bulk operation on the specified\ \ custom object records. A succcessful call returns a newly created bulk job.\ \ The job ID can be used to poll the job status or upload the CSV file if\ \ it is a `create` or `update` job.\n\n### Limits\nThis custom object bulk\ \ jobs have the following limits:\n* The concurrent bulk job limit per tenant\ \ is 5. Bulk jobs in `accepted`, `pending`, or `in_progress` status are counted\ \ towards the concurrent bulk job limit.\n* The bulk job execuation order\ \ is not guaranteed, which means the bulk job that you submit ealier may be\ \ executed later. \n* Only the users that have the \"Delete Custom Objects\"\ \ permission can create a `delete` bulk job. Only the users that have the\ \ \"Edit Custom Objects\" permission can create a `create` or `update` bulk\ \ job. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions)\ \ for more information.\n" operationId: POST_CustomObjectBulkJob tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: CustomObjectBulkJobRequest in: body description: Custom Objects bulk job request required: true schema: $ref: '#/definitions/CustomObjectBulkJobRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CustomObjectBulkJobResponse' '400': description: Invalid input 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013020 message: Bad Request '403': description: Unauthorized 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71012514 message: User does not have permission to delete custom objects. get: summary: List all custom object bulk jobs description: 'Lists all custom object bulk jobs submitted by your tenant. ' operationId: GET_AllCustomObjectBulkJobs tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: pageSize maximum: 100 default: 25 description: The number of records returned per page in the response. in: query required: false type: integer - name: cursor description: The `cursor` points to the last job of the previous result set. The cursor job is not included in this query result. The call returns the first page if `cursor` is not provided and `pageSize` is valid. in: query required: false type: string - name: status description: The status of bulk jobs to be retrieved. in: query required: false type: string enum: - pending - accepted - in_progress - completed - failed - cancelled responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CustomObjectBulkJobResponseCollection' x-code-samples: - lang: curl label: Curl source: 'curl -X GET -H "Authorization: Bearer e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type: application/json" "https://rest.zuora.com/objects/jobs?pageSize=2&cursor=a9e9a58d-0a11-4685-b1ab-99521dbc20a1" ' /objects/jobs/{id}: get: summary: Retrieve a custom object bulk job description: | Retrieves the custom object bulk job details by job ID. Only the users that have the "View Custom Objects" permission can retrieve custom object bulk jobs. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information. operationId: GET_CustomObjectBulkJob tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: id in: path description: The ID of the custom object bulk job to be retrieved. required: true type: string format: uuid responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CustomObjectBulkJobResponse' '404': description: Bulk job not found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013040 message: Not Found. /objects/jobs/{id}/files: post: summary: Upload a file for a custom object bulk job description: | Uploads a `.csv` file for a custom object bulk job to create or update custom object records. The job must be in `pending` status. Only one file is allowed per job. Each file supports only one type of operation, with an `id` column required for update operations. The job will start once the upload is finished. Only the users that have the "Edit Custom Objects" permission can upload files to custom object bulk jobs. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information. operationId: POST_UploadFileForCustomObjectBulkJob tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: Content-Type in: header required: true type: string description: The `Content-Type` of the request must be `text/csv`. - name: id in: path description: The ID of the custom object bulk job that the file is uploaded to. required: true type: string format: uuid - name: file in: body required: true schema: type: string description: The CSV file to be uploaded. The file must be encoded in UTF-8 and the file size limit is 15 MB. consumes: - text/csv responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CustomObjectBulkJobResponse' examples: application/json: Id: 5112347a-f7a1-4373-99df-c082984de7be CreatedById: 2c92c0f96a07409d016a0a58ab1172ec UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec CreatedDate: '2021-03-10T00:05:54.207Z' UpdatedDate: '2021-03-10T00:08:15.539Z' operation: create namespace: default object: vehicle status: in_progress processingTime: 0 recordsProcessed: 0 '400': description: Bad request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013620 message: Bad Request '404': description: Job not found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013040 message: Not Found. '403': description: Unauthorized 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71012515 message: User does not have permission to create custom objects. x-code-samples: - lang: curl label: Curl source: 'curl -X POST -H "Authorization: Bearer e5cb941a9b1f47838b4085b4d5e00415" -H "Content-Type: text/csv" --data-binary "@CustomObjectRecords.csv" "https://rest.zuora.com/objects/jobs/5112347a-f7a1-4373-99df-c082984de7be/files" ' /objects/jobs/{id}/errors: get: summary: List all errors for a custom object bulk job description: 'Lists all errors for a custom object bulk job. ' operationId: GET_CustomObjectBulkJobErrors tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: id in: path description: The ID of the custom object bulk job that you retrieve errors for. required: true type: string format: uuid responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CustomObjectBulkJobErrorResponseCollection' '404': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Job not found schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013040 message: Not Found. /objects/jobs/{id}/cancel: patch: summary: Cancel a custom object bulk job description: 'Cancel a custom object bulk job. Note that you can cancel a custom object bulk job only if the job status is `accepted` or `pending`. ' operationId: PATCH_CustomObjectBulkJob tags: - Custom Object Jobs parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $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_HEADER_Authorization_OAuth' - name: Zuora-Version in: header required: false type: string format: date description: API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in the request header if you expect a specific response schema. - name: id in: path description: The ID of the custom object bulk job that you want to cancel. required: true type: string format: uuid responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CustomObjectBulkJobResponse' examples: application/json: Id: 7f19b861-5ec7-479b-935c-fcfbd6477655 CreatedById: 11e64eef-ada8-786d-9658-00259058c29c UpdatedById: 0fdfc048-0a9e-433f-ad23-d50e31448b2e CreatedDate: '2022-12-01T21:24:04.337Z' UpdatedDate: '2022-12-01T21:37:43.212Z' operation: create namespace: default object: jobtest status: cancelled processingTime: 0 recordsProcessed: 0 '400': description: Bad request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013620 message: Bad Request '404': 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: Job not found schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: code: 71013040 message: Job not found for id '7006ce52-91c9-11ed-a1eb-0242ac120002'. /events/scheduled-events: post: tags: - Custom Scheduled Events summary: Create a scheduled event operationId: POST_ScheduledEvent description: 'To create a custom scheduled event, you must specify the base object, the base field and the scheduled time. ' 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: postScheduledEventRequest in: body required: true schema: $ref: '#/definitions/PostScheduledEventRequest' responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetScheduledEventResponse' 400: description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: FieldConstraintViolation message: name should follow ^[A-Za-z]{1,}[\w\-]*$ 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: SystemError message: internal server error get: tags: - Custom Scheduled Events summary: List all scheduled events operationId: GET_ScheduledEvents parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: eventTypeName in: query description: 'The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$' required: false type: string - name: apiObject in: query description: 'The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' required: false type: string - name: apiField in: query description: 'The base field of the base object in the `apiObject` field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' required: false type: string - name: active in: query description: Indicate whether the scheduled event is active or inactive. required: false type: boolean - name: start in: query description: The first index of the query result. Default to 0 if absent, and the minimum is 0. required: false type: integer default: 0 minimum: 0 - name: limit in: query description: The maximum number of data records to be returned. Default to 10 if absent. required: false type: integer default: 10 minimum: 1 responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: type: object properties: data: type: array items: $ref: '#/definitions/GetScheduledEventResponse' next: type: string description: The link to the next page. No value if it is last page. example: /events/scheduled-events?start=10&limit=10 400: description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: SystemError message: internal server error /events/scheduled-events/{id}: get: tags: - Custom Scheduled Events summary: Retrieve a scheduled event by ID operationId: GET_ScheduledEventByID parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: The ID of the scheduled event. required: true type: string responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetScheduledEventResponse' 404: description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: ResourceNotFound message: no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: SystemError message: internal server error put: tags: - Custom Scheduled Events summary: Update a scheduled event by ID operationId: UPDATE_ScheduledEventByID parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: The ID of the scheduled event. required: true type: string - name: putScheduledEventRequest in: body required: true schema: $ref: '#/definitions/PutScheduledEventRequest' responses: 200: description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetScheduledEventResponse' 400: description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: FieldConstraintViolation message: name should follow ^[A-Za-z]{1,}[\w\-]*$ 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: SystemError message: internal server error delete: tags: - Custom Scheduled Events summary: Delete a scheduled event by ID operationId: DELETE_ScheduledEventByID parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: id in: path description: The ID of the scheduled event. required: true type: string responses: 204: description: No Content 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' 404: description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: ResourceNotFound message: no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5 500: description: Server Error 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/ErrorResponse' examples: application/json: reasons: - code: SystemError message: internal server error /v1/multi-organizations/data-labeling-job: post: operationId: POST_DataLabelingJob summary: Submit a data labeling job description: 'Submits a data labeling job. ' tags: - Data Labeling 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: body in: body required: true description: '' schema: $ref: '#/definitions/SubmitDataLabelingJobRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/SubmitDataLabelingJobResponse' examples: application/json: success: true jobId: ff80808186beca0a0186bedbf7d3006f jobStatus: Accepted '400': description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: success: false processId: 4C0112A0983D040C reasons: - code: 59620220 message: The queryType is invalid requestId: 46a352ed-57a2-4a9f-b7cb-a8c864d839f3 /v1/multi-organizations/data-labeling-job/{job-id}: get: operationId: GET_DataLabelingJob summary: Retrieve a data labeling job description: 'Retrieves a data labeling job. You can use this operation to track the status of the data labeling job. ' tags: - Data Labeling parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: job-id in: path required: true type: string format: uuid minLength: 32 maxLength: 32 description: 'Identifier of the data labeling job. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetDataLabelingJobResponse' examples: application/json: success: true jobId: ff80808186b966950186b97922e200ab objectType: Account totalObject: 11 jobStatus: Completed progress: labeled: 9 failed: 1 timeout: 1 '404': description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/CommonErrorResponse' examples: application/json: success: false processId: 4C0112A0983D039B reasons: - code: 50000020 message: The job does not exist requestId: 46a352ed-57a2-4a9f-b7cb-a8c864d839f3 /query/jobs: post: operationId: POST_DataQueryJob summary: Submit a data query description: 'Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be performed by Zuora and creates a query job. You can use [Retrieve a data query job](#operation/GET_DataQueryJob) to track the status of the query job and obtain the URL of the query results. ' tags: - Data Queries 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' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: body in: body required: true description: '' schema: $ref: '#/definitions/SubmitDataQueryRequest' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/SubmitDataQueryResponse' examples: application/json: data: id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: accepted remainingRetries: 3 updatedOn: '2018-08-17T13:14:18.204Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 '400': description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DataQueryErrorResponse' examples: application/json: code: 400 message: Unable to process JSON get: operationId: GET_DataQueryJobs summary: List data query jobs description: | Returns a list of [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) jobs that have been created in your Zuora tenant. You can filter the list by status. If you are an administrator, you can retrieve all the query jobs in your tenant. Otherwise, you can only retrieve your own query jobs. tags: - Data Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: queryStatus in: query required: false type: string enum: - accepted - in_progress - completed - failed - cancelled description: 'Filters the list of query jobs by status. ' - name: pageSize in: query required: false type: integer maximum: 100 default: 20 description: 'The number of records returned per page in the response. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetDataQueryJobsResponse' examples: application/json: data: - id: bf3b5640-ddd1-4b4f-9a81-906ec2b84a89 query: SELECT s.id FROM Subscription s JOIN RatePlan rp ON s.id = rp.subscriptionid WHERE rp.name = 'Premium Monthly' useIndexJoin: false sourceData: LIVE queryStatus: in_progress remainingRetries: 3 updatedOn: '2018-08-17T13:14:38.855Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 - id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: completed dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... outputRows: 24516 processingTime: 9212 remainingRetries: 3 updatedOn: '2018-08-17T13:14:19.17Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 /query/jobs/{job-id}: get: operationId: GET_DataQueryJob summary: Retrieve a data query job description: "Retrieves a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query)\ \ job. You can use this operation to track the status of the query job and\ \ obtain the URL of the query results.\n\nIf you are an administrator, you\ \ can retrieve every query job in your tenant. \n\nIf you are a non-admin\ \ user and try to retrieve a query job that you are not the owner of, you\ \ will get a 403 response indicating that you are forbidden from viewing this\ \ job. As a non-admin user, you can only retrieve your own query job.\n" tags: - Data Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: job-id in: path required: true type: string format: uuid minLength: 36 maxLength: 36 description: 'Internal identifier of the query job. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/GetDataQueryJobResponse' examples: application/json: data: id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: completed dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... outputRows: 24516 processingTime: 9212 remainingRetries: 3 updatedOn: '2018-08-17T13:14:19.17Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 '403': description: Forbidden 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DataQueryErrorResponse' examples: application/json: code: 1009 message: Access denied for restricted job ea50af05-6163-47e1-bf9b-c8e10648d8a3 '404': description: Not Found 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DataQueryErrorResponse' examples: application/json: code: 1001 message: 'No such query: 1e8e8586-5366-4cdf-a01d-fae3b2cf8427' delete: operationId: DELETE_DataQueryJob summary: Cancel a data query job description: 'Cancels a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) job, which prevents Zuora from performing the query. This operation is only applicable if the status of the query job is `accepted` or `in_progress`. ' tags: - Data Queries parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: job-id in: path required: true type: string format: uuid minLength: 64 maxLength: 64 description: 'Internal identifier of the query job. ' responses: '200': description: OK 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DeleteDataQueryJobResponse' examples: application/json: data: id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: cancelled remainingRetries: 3 updatedOn: '2018-08-17T13:22:16.965Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 '400': description: Bad Request 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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. ' schema: $ref: '#/definitions/DataQueryErrorResponse' examples: application/json: code: 1003 message: Query job c20a8ff4-3960-4c85-b067-d5259035f523 is not in accepted or in_progress status /v1/debitmemos: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCreates an ad-hoc debit memo from a product rate\ \ plan charge. Zuora supports the creation of debit memos from any type of\ \ product rate plan charge. The charges can also have any amount and any charge\ \ model, except for discout charge models.\n\nWhen debit memos are created\ \ from product rate plan charges, the specified amount with decimal places\ \ is now validated based on the decimal places supported by each currency.\n\ \nYou can create a debit memo only if you have the user permission. See [Billing\ \ Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Create a debit memo from a charge operationId: POST_DebitMemoFromPrpc tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018712e8ed250a5b number: DM00000001 accountId: 4028ab1f87121698018712e8e8fe0a4a accountNumber: AN_1679649466484 debitMemoDate: '2023-03-24' currency: USD targetDate: null dueDate: '2023-04-23' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: test referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-24 14:47:47' createdById: ee47f07f310c4bbeb436bb9ec0e0e627 updatedDate: '2023-03-24 14:47:47' updatedById: ee47f07f310c4bbeb436bb9ec0e0e627 cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `charges` > `amount`\n\ * `charges` > `memoItemAmount`\n* `charges` > `chargeId`\n* `charges` >\ \ `productRatePlanChargeId` \n* `charges` > `comment`\n* `charges`\ \ > `description`\n* `customRates` > `currency`\n* `customRates` > `customFxRate`\ \ \n* `customRates` > `rateDate`\n" - name: body in: body description: '' required: true schema: $ref: '#/definitions/DebitMemoFromChargeType' put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nUpdates the due date for multiple debit memos in\ \ one single request. \n\nThis API operation will be deprecated. You can use\ \ the [Update debit memos](https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos)\ \ instead, which provides more flexible functionality.\n" summary: Update due dates for debit memos operationId: PUT_UpdateDebitMemosDueDates tags: - Debit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body description: '' required: true schema: $ref: '#/definitions/PUTBatchDebitMemosRequest' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nRetrieves the information about all debit memos\ \ associated with all customer accounts.\n\n### Filtering\n\nYou can use query\ \ parameters to restrict the data returned in the response. Each query parameter\ \ corresponds to one field in the response body.\n\nIf the value of a filterable\ \ field is string, you can set the corresponding query parameter to `null`\ \ when filtering. Then, you can get the response data with this field value\ \ being `null`. \n\nExamples:\n\n- /v1/debitmemos?status=Posted\n\n- /v1/debitmemos?referredInvoiceId=null&status=Draft\n\ \n- /v1/debitmemos?status=Posted&type=External&sort=+number\n" summary: List debit memos operationId: GET_DebitMemos tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: debitmemos: - id: 402890555a87d7f5015a892f2ba10057 number: DM00000006 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466484 debitMemoDate: '2017-10-17' targetDate: null dueDate: '2017-11-16' postedOn: null postedById: null status: Draft sourceType: Standalone amount: 50 taxAmount: 0 totalTaxExemptAmount: 0 balance: 50 beAppliedAmount: 0 autoPay: true comment: the comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2017-03-01 17:24:14' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:24:14' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 402890555a87d7f5015a892f2c5c0060 taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null - id: 402890555a87d7f5015a89251edc0045 number: DM00000003 accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 debitMemoDate: '2017-11-30' targetDate: null dueDate: '2017-12-30' postedOn: null postedById: null status: Draft sourceType: Standalone amount: 0.01 taxAmount: 0.01 totalTaxExemptAmount: 0 balance: 0.01 beAppliedAmount: 0 autoPay: true comment: the comment referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 transferredToAccounting: 'No' reasonCode: Charge Dispute createdDate: '2017-03-01 17:13:15' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: null taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null - id: 402890555a87d7f5015a8919e4fe002e number: DM00000002 accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 debitMemoDate: '2017-03-01' targetDate: null dueDate: '2017-03-31' postedOn: null postedById: null status: Draft sourceType: Standalone amount: 9 taxAmount: 8 totalTaxExemptAmount: 0 balance: 9 beAppliedAmount: 0 autoPay: true comment: '' referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 referredCreditMemoId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2017-03-01 17:01:00' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 402890555a87d7f5015a8919e95d003a taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null - id: 402890555a7e9791015a87b082940067 number: DM00000001 accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466684 debitMemoDate: '2017-03-01' targetDate: null dueDate: '2017-03-31' postedOn: null postedById: null status: Draft sourceType: Standalone amount: 8.02 taxAmount: 0.02 totalTaxExemptAmount: 0 balance: 8.02 beAppliedAmount: 0 autoPay: true comment: '' referredInvoiceId: 402890555a7e9791015a7f1756aa0035 referredCreditMemoId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2017-03-01 10:26:16' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:45:03' updatedById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: null cancelledById: null latestPDFFileId: 402890555a7e9791015a87b083f00072 taxStatus: null taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null success: true schema: $ref: '#/definitions/GETDebitMemoCollectionType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - name: accountId in: query type: string required: false description: 'This parameter filters the response based on the `accountId` field. ' - name: accountNumber in: query type: string required: false description: 'This parameter filters the response based on the `accountNumber` field. ' - name: amount in: query type: number format: double required: false description: 'This parameter filters the response based on the `amount` field. ' - name: balance in: query type: number format: double required: false description: 'This parameter filters the response based on the `balance` field. ' - name: beAppliedAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `beAppliedAmount` field. ' - name: createdById in: query type: string required: false description: 'This parameter filters the response based on the `createdById` field. ' - name: createdDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `createdDate` field. ' - name: currency in: query type: string required: false description: 'This parameter filters the response based on the `currency` field. ' - name: debitMemoDate in: query type: string format: date required: false description: 'This parameter filters the response based on the `debitMemoDate` field. ' - name: dueDate in: query type: string format: date required: false description: 'This parameter filters the response based on the `dueDate` field. ' - name: number in: query type: string required: false description: 'This parameter filters the response based on the `number` field. ' - name: referredInvoiceId in: query type: string required: false description: 'This parameter filters the response based on the `referredInvoiceId` field. ' - name: status in: query type: string enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress required: false description: 'This parameter filters the response based on the `status` field. ' - name: targetDate in: query type: string format: date required: false description: 'This parameter filters the response based on the `targetDate` field. ' - name: taxAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `taxAmount` field. ' - name: totalTaxExemptAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `totalTaxExemptAmount` field. ' - name: updatedById in: query type: string required: false description: 'This parameter filters the response based on the `updatedById` field. ' - name: updatedDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `updatedDate` field. ' - name: sort in: query type: string required: false description: "This parameter restricts the order of the data returned in the\ \ response. You can use this parameter to supply a dimension you want to\ \ sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\ \nYou can use at most two sortable fields in one URL path. Use a comma to\ \ separate sortable fields. For example: *operator* *field_name*, *operator*\ \ *field_name* \n\n*operator* is used to mark the order of sequencing.\ \ The operator is optional. If you only specify the sortable field without\ \ any operator, the response data is sorted in descending order by this\ \ field.\n\n - The `-` operator indicates an ascending order.\n - The\ \ `+` operator indicates a descending order.\n\nBy default, the response\ \ data is displayed in descending order by debit memo number.\n\n*field_name*\ \ indicates the name of a sortable field. The supported sortable fields\ \ of this operation are as below:\n\n - number\n - accountId\n - debitMemoDate\n\ \ - targetDate\n - dueDate\n - amount\n - taxAmount\n - totalTaxExemptAmount\n\ \ - balance\n - beAppliedAmount\n - referredInvoiceId\n - createdDate\n\ \ - createdById\n - updatedDate\n - updatedById\n \nExamples:\n\n- /v1/debitmemos?sort=+number\n\ \n- /v1/debitmemos?status=Processed&sort=-number,+amount\n" /v1/debitmemos/bulk: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nCreates multiple debit memos from invoices or product\ \ rate plan charges. You can create a maximum of 50 debit memos in one single\ \ request. \n\n- If you set the `sourceType` request field to `Invoice`, you\ \ can create multiple debit memos from invoices.\n- If you set the `sourceType`\ \ request field to `Standalone`, you can create multiple debit memos from\ \ product rate plan charges.\n\nThe debit memos that are created are each\ \ in separate database transactions. If the creation of one debit memo fails,\ \ other debit memos can still be created successfully.\n\nYou can create \ \ debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Create debit memos operationId: POST_CreateDebitMemos tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true memos: - id: 4028ab1f87121698018712ff1b0633e2 number: DM00000001 accountId: 4028ab1f87121698018712fef63e33cb accountNumber: AN_Test11679650911374 debitMemoDate: '2023-03-24' currency: USD targetDate: null dueDate: '2023-03-24' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: This is a comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-24 15:12:01' createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b updatedDate: '2023-03-24 15:12:01' updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true - success: false processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. objectIndex: 1 schema: $ref: '#/definitions/BulkDebitMemosResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTBulkDebitMemosRequestType' put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information.\n\nUpdates the basic and finance information about\ \ multiple debit memos. You can update a maximum of 50 credit memos in one\ \ single request.\n \nThe credit memos that are updated are each in separate\ \ database transactions. If the update of one debit memo fails, other debit\ \ memos can still be updated successfully.\n\nCurrently, Zuora supports updating\ \ tax-exclusive memo items, but does not support updating tax-inclusive memo\ \ items.\n\nIf the amount of a memo item is updated, the tax will be recalculated\ \ in the following conditions:\n - The memo is created from a product rate\ \ plan charge and you use Avalara to calculate the tax.\n - The memo is created\ \ from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\ \nYou can update debit memos only if you have the user permission. See [Billing\ \ Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Update debit memos operationId: PUT_UpdateDebitMemos tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true memos: - id: 4028ab1f8712169801872685a5f46605 number: DM00000001 accountId: 4028ab1f87121698018726851cc765ee accountNumber: AN_Test11679978470016 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: new comment123 referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-28 10:11:45' createdById: aff81dbb5dd846868685592640363b5b updatedDate: '2023-03-28 10:12:37' updatedById: aff81dbb5dd846868685592640363b5b cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true - id: 2c98907562482a8301624b9c0a1a0056 processId: string reasons: - code: string message: string objectIndex: 1 success: false schema: $ref: '#/definitions/BulkDebitMemosResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: zuora-version in: header required: false type: string description: |2 The minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) for information about REST API version control. - name: body in: body description: '' required: true schema: $ref: '#/definitions/PUTBulkDebitMemosRequestType' /v1/invoices/{invoiceKey}/debitmemos: post: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCreates an ad-hoc debit memo from an invoice.\n\ \nYou can create a debit memo from an invoice only if you have the user permission.\ \ See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Create a debit memo from an invoice operationId: POST_DebitMemoFromInvoice tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018712fc005a2ba7 number: DM00000001 accountId: 4028ab1f87121698018712fb22312b70 accountNumber: AN_Test11679650660490 debitMemoDate: '2023-04-29' currency: USD targetDate: null dueDate: '2023-04-29' postedOn: null postedById: null status: Draft amount: 1.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 1.0 beAppliedAmount: 0.0 autoPay: true comment: the comment referredInvoiceId: 4028ab1f87121698018712fb2a3b2b91 transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-24 15:08:37' createdById: bd19d326bce5465c81df19d3262954c3 updatedDate: '2023-03-24 15:08:37' updatedById: bd19d326bce5465c81df19d3262954c3 cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: null sourceType: Invoice taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. ' name: invoiceKey required: true - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following request fields:\n* `items` > `comment`\n\ * `items` > `description`\n" - name: body in: body description: '' required: true schema: $ref: '#/definitions/DebitMemoFromInvoiceType' /v1/debitmemos/{debitMemoKey}: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about a specific debit\ \ memo.\n" summary: Retrieve a debit memo operationId: GET_DebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018722ff2bff58b8 number: DM00000001 accountId: 4028ab1f87121698018722ff25be58a1 accountNumber: AN_Test11679919358984 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: This is a comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-27 17:46:01' createdById: 0124a1a5d0f84d4288d875fc3b34b1e1 updatedDate: '2023-03-27 17:46:01' updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1 cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' name: debitMemoKey required: true put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUpdates the basic and finance information about\ \ a debit memo. Currently, Zuora supports updating tax-exclusive memo items,\ \ but does not support updating tax-inclusive memo items. \n\nIf the amount\ \ of a memo item is updated, the tax will be recalculated in the following\ \ conditions:\n - The memo is created from a product rate plan charge and\ \ you use Avalara to calculate the tax.\n - The memo is created from an invoice\ \ and you use Avalara or Zuora Tax to calculate the tax.\n\nYou can update\ \ a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Update a debit memo operationId: PUT_DebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018722f8335b3ffb number: DM00000001 accountId: 4028ab1f87121698018722f82d133fe4 accountNumber: AN_Test11679918902100 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: new comment123 referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-27 17:38:24' createdById: 97e12d40f0ab4418a95a93118b272fb6 updatedDate: '2023-03-27 17:38:27' updatedById: 97e12d40f0ab4418a95a93118b272fb6 cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body required: true schema: $ref: '#/definitions/PUTDebitMemoType' - type: string in: path name: debitMemoKey description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' required: true delete: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nDeletes a debit memo. Only debit memos with the\ \ Cancelled status can be deleted. \n\nYou can delete a debit memo only if\ \ you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Delete a debit memo operationId: DELETE_DebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. ' name: debitMemoKey required: true /v1/debitmemos/{debitMemoId}/application-parts: get: summary: List all application parts of a debit memo description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves information about the payments or credit\ \ memos that are applied to a specified debit memo.\n" operationId: GET_DebitMemoApplicationParts tags: - Debit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: debitMemoId in: path type: string required: true description: 'The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: OK examples: application/json: applicationParts: - paymentId: null creditMemoId: 4028905f60a165a50160b4f632ff023d appliedAmount: 22 createdDate: '2018-01-02 11:42:16' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' updatedById: 402881e522cf4f9b0122cf5d82860002 - paymentId: 4028905f60a165a50160b4f5d5cb0229 creditMemoId: null appliedAmount: 11 createdDate: '2018-01-02 11:41:38' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' updatedById: 402881e522cf4f9b0122cf5d82860002 success: true schema: $ref: '#/definitions/GetDebitMemoApplicationPartCollectionType' /v1/debitmemos/{debitMemoKey}/cancel: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nCancels a debit memo. Only debit memos with the\ \ Draft status can be cancelled. \n\nYou can cancel a debit memo only if you\ \ have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n" summary: Cancel a debit memo operationId: PUT_CancelDebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018722fd34c6507d number: DM00000001 accountId: 4028ab1f87121698018722fd2e705066 accountNumber: AN_Test11679919230033 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: null postedById: null status: Canceled amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: This is a comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-27 17:43:52' createdById: bc0211e8ca1440eb97a0aff808f87293 updatedDate: '2023-03-27 17:43:59' updatedById: bc0211e8ca1440eb97a0aff808f87293 cancelledOn: '2023-03-27 17:43:59' cancelledById: bc0211e8ca1440eb97a0aff808f87293 referredCreditMemoId: null latestPDFFileId: 4028ab1f87121698018722fd39fe5087 taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. ' name: debitMemoKey required: true /v1/debitmemos/{debitMemoKey}/collect: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. This API operation provides an easy way to let the client-side to collect an existing posted debit memo. It supports the following steps: 1. Apply unapplied credit memos to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied credit memos. 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments. 3. Process payment to the posted debit memo if there is an open-balance on it. **Restrictions** Since this API will do lots of works, and some of them are resource consuming, we need to restrict the usage of this API by the following conditions: 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected. 2. If `CreditMemo` is specified in `applicationOrder`, when there are more than 25 credit memos will be used to apply to the debit memo, the request will be rejected. 3. If `CreditMemo` is specified in `applicationOrder`, when there are more than 100 credit memo items will be used to apply to the debit memo, the request will be rejected. 4. If `UnappliedPayment` is specified in `applicationOrder`, when there are more than 25 payments will be used to apply to the debit memo, the request will be rejected. summary: Collect a posted debit memo operationId: POST_DebitMemoCollect tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' description: '' examples: application/json: debitMemo: id: 2c98902f6f1de6d1016f1dfc86aa3c34 number: DM00003326 appliedCreditMemos: - id: 2c98902f6f1de6d1016f1def4c003bd8 number: CM00000452 appliedAmount: 12.8 unappliedAmount: 0E-9 - id: 2c98902f6f1de6d1016f1deef1b93bbe number: CM00009201 appliedAmount: 9.99 unappliedAmount: 0E-9 appliedPayments: - id: 2c98902f6f1de6d1016f1defbf3e3bf5 number: P-00001602 appliedAmount: 3.33 unappliedAmount: 0E-9 - id: 2c98902f6f1de6d1016f1def887f3bec number: P-00001761 appliedAmount: 1.2 unappliedAmount: 0E-9 processedPayment: id: 2c98902f6f1de6d1016f1dfc8ad23c68 number: P-00001803 status: Processed amount: 12.68 paymentMethodId: 2c98902f6f1de6d1016f1dedba313ba2 gatewayId: 2c98902f6f1de6d1016f1ded559f3b9d gatewayResponse: This transaction has been approved by Test gateway. gatewayResponseCode: approve success: true schema: $ref: '#/definitions/DebitMemoCollectResponse' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: body in: body required: true schema: $ref: '#/definitions/DebitMemoCollectRequest' - name: debitMemoKey in: path type: string required: true description: 'The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. ' /v1/debitmemos/{debitMemoKey}/emails: post: summary: Email a debit memo operationId: POST_EmailDebitMemo description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nSends a posted debit memo to the specified email\ \ addresses manually.\n\n\n\n### Notes\n - You must activate the **Email\ \ Debit Memo | Manually email Debit Memo** notification before emailing debit\ \ memos. To include the debit memo PDF in the email, select the **Include\ \ Debit Memo PDF** check box in the **Edit notification** dialog from the\ \ Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2)\ \ for more information.\n\n\n - Zuora sends the email messages based on the\ \ email template you set. You can set the email template to use in the **Delivery\ \ Options** panel of the **Edit notification** dialog from the Zuora UI. By\ \ default, the **Manual Email for Debit Memo Default Template** template is\ \ used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates)\ \ for more information.\n\n\n - The debit memos are sent only to the work\ \ email addresses or personal email addresses of the Bill To contact if the\ \ following conditions are all met:\n\n * The `useEmailTemplateSetting`\ \ field is set to `false`.\n * The email addresses are not specified in\ \ the `emailAddresses` field.\n" tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: success: true schema: $ref: '#/definitions/CommonResponseType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: Request in: body required: true description: '' schema: $ref: '#/definitions/PostDebitMemoEmailType' - name: debitMemoKey in: path type: string required: true description: 'The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' /v1/debitmemos/{debitMemoKey}/files: post: summary: Upload a file for a debit memo operationId: POST_UploadFileForDebitMemo description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUploads an externally generated PDF file for a\ \ debit memo that is in Draft or Posted status.\n\nTo use this operation,\ \ you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles)\ \ for more information.\n\nThis operation has the following restrictions:\n\ - Only the PDF file format is supported.\n- The maximum size of the PDF file\ \ to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one\ \ debit memo.\n" consumes: - multipart/form-data tags: - Debit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: debitMemoKey in: path description: 'The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001. ' required: true type: string - name: file in: formData description: 'The PDF file to upload for the debit memo. ' type: file responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true fileId: 40289f466463d683016463ef8b7301a3 description: '' schema: $ref: '#/definitions/POSTUploadFileResponse' x-code-samples: - lang: curl label: Curl source: 'curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debitmemos/402890555a87d7f5015a8919e4fe002e/files" ' /v1/debitmemos/{debitMemoKey}/items: get: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nRetrieves the information about all items of a\ \ debit memo. A debit memo item is a single line item in a debit memo. \n\n\ ### Filtering\n\nYou can use query parameters to restrict the data returned\ \ in the response. Each query parameter corresponds to one field in the response\ \ body.\n\nIf the value of a filterable field is string, you can set the corresponding\ \ query parameter to `null` when filtering. Then, you can get the response\ \ data with this field value being `null`. \n\nExamples:\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100\n\ \n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n" summary: List debit memo items operationId: GET_DebitMemoItems tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: items: - id: 402890555a87d7f5015a89251ede0046 amount: 1 amountWithoutTax: 1 beAppliedAmount: 0 balance: 1 taxMode: TaxExclusive sku: SKU-00000002 skuName: SKU-30 serviceStartDate: '2017-11-01' serviceEndDate: '2017-11-30' sourceItemType: InvoiceDetail sourceItemId: 402890555a7d4022015a7dadb3b700a6 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 excludeItemBillingFromRevenueAccounting: true processingType: Charge createdDate: '2017-03-01 17:13:15' createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' updatedById: 402881e522cf4f9b0122cf5d82860002 comment: This is comment! subscriptionId: null unitOfMeasure: Each unitPrice: 1 quantity: 1 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue taxationItems: data: - id: 402890555a87d7f5015a89251ef10047 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 0.01 balance: 0.01 paymentAmount: 0 creditAmount: 0 name: STATE TAX exemptAmount: 0 jurisdiction: CALIFORNIA locationCode: '06' taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-11-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null success: true schema: $ref: '#/definitions/GETDebitMemoItemCollectionType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_page' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' name: debitMemoKey required: true - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following response fields:\n* `items` > `taxItems`\n\ * `items` > `taxationItems`\n* `items` > `comment`\n* `items` > `description`\n" - name: amount in: query type: number format: double required: false description: 'This parameter filters the response based on the `amount` field. ' - name: beAppliedAmount in: query type: number format: double required: false description: 'This parameter filters the response based on the `beAppliedAmount` field. ' - name: createdById in: query type: string required: false description: 'This parameter filters the response based on the `createdById` field. ' - name: createdDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `createdDate` field. ' - name: id in: query type: string required: false description: 'This parameter filters the response based on the `id` field. ' - name: serviceEndDate in: query type: string format: date required: false description: 'This parameter filters the response based on the `serviceEndDate` field. ' - name: serviceStartDate in: query type: string format: date required: false description: 'This parameter filters the response based on the `serviceStartDate` field. ' - name: sku in: query type: string required: false description: 'This parameter filters the response based on the `sku` field. ' - name: skuName in: query type: string required: false description: 'This parameter filters the response based on the `skuName` field. ' - name: sourceItemId in: query type: string required: false description: 'This parameter filters the response based on the `sourceItemId` field. ' - name: subscriptionId in: query type: string required: false description: 'This parameter filters the response based on the `subscriptionId` field. ' - name: updatedById in: query type: string required: false description: 'This parameter filters the response based on the `updatedById` field. ' - name: updatedDate in: query type: string format: date-time required: false description: 'This parameter filters the response based on the `updatedDate` field. ' - name: sort in: query type: string required: false description: "This parameter restricts the order of the data returned in the\ \ response. You can use this parameter to supply a dimension you want to\ \ sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\ \nYou can use at most two sortable fields in one URL path. Use a comma to\ \ separate sortable fields. For example: *operator* *field_name*, *operator*\ \ *field_name* \n\n*operator* is used to mark the order of sequencing.\ \ The operator is optional. If you only specify the sortable field without\ \ any operator, the response data is sorted in descending order by this\ \ field.\n\n - The `-` operator indicates an ascending order.\n - The\ \ `+` operator indicates a descending order.\n\nBy default, the response\ \ data is displayed in descending order by updated date.\n\n*field_name*\ \ indicates the name of a sortable field. The supported sortable fields\ \ of this operation are as below:\n\n - id\n - amount\n - beAppliedAmount\n\ \ - sku\n - skuName\n - serviceStartDate\n - serviceEndDate\n - sourceItemId\n\ \ - createdDate\n - createdById\n - updatedDate\n - updatedById\n -\ \ subscriptionId\n \nExamples:\n\n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate\n\ \n- /v1/debitmemos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n" /v1/debitmemos/{debitMemoKey}/items/{dmitemid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo. summary: Retrieve a debit memo item operationId: GET_DebitMemoItem tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 402890555a87d7f5015a8919e500002f amount: 1 amountWithoutTax: 1 beAppliedAmount: 0 balance: 1 quantity: 1 taxMode: TaxExclusive sku: SKU-00000002 skuName: ZTax Component serviceStartDate: '2017-02-27' serviceEndDate: '2017-03-26' sourceItemType: InvoiceDetail sourceItemId: 402890555a7d4022015a7dadb3b700a6 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 processingType: Charge createdDate: '2017-03-01 17:01:00' excludeItemBillingFromRevenueAccounting: true createdById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' updatedById: 402881e522cf4f9b0122cf5d82860002 comment: aa subscriptionId: null unitOfMeasure: Each unitPrice: 1 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue taxationItems: data: - id: 402890555a87d7f5015a8919e8450031 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 5 balance: 5 paymentAmount: 0 creditAmount: 0 name: my tax exemptAmount: 0 jurisdiction: USA locationCode: '' taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: desc3 taxRateType: FlatFee financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null success: true schema: $ref: '#/definitions/GETDebitMemoItemType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). ' name: dmitemid required: true - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' name: debitMemoKey required: true - name: zuora-version in: header required: false type: string description: "\nThe minor version of the Zuora REST API. See [Minor Version](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version)\ \ for information about REST API version control. \n\nThis header affects\ \ the availability of the following response fields:\n* `taxItems`\n* `taxationItems`\n\ * `comment`\n* `description`\n" /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves information about the taxation items of a specific debit memo item. summary: List all taxation items of a debit memo item operationId: GET_TaxationItemsOfDebitMemoItem tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: "A custom identifier for tracing the API call. If you specified\ \ a tracing identifier in the request headers, Zuora returns the same\ \ tracing identifier. Otherwise, Zuora does not set this header. \ \ \n" description: '' examples: application/json: data: - balance: 10 sourceTaxItemId: null paymentAmount: 0 creditAmount: 0 financeInformation: salesTaxPayableAccountingCode: null salesTaxPayableAccountingCodeType: null id: 402883836904567d01690530df760231 taxAmount: 10 name: taxName_0 exemptAmount: 10 jurisdiction: Jurisdiction locationCode: '8' taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage success: true schema: $ref: '#/definitions/GETTaxationItemsOfDebitMemoItemType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/parameters/GLOBAL_REQUEST_page' - type: string in: path description: 'The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems). ' name: dmitemid required: true - type: string in: path description: 'The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. ' name: debitMemoId required: true /v1/debitmemos/{debitMemoKey}/pdfs: post: summary: Generate a debit memo PDF file description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a PDF file for a specified debit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed debit memo page through the Zuora UI. This REST API operation can be used only if you have the billing document file generation feature and the Billing user permission "Regenerate PDF" enabled. operationId: POST_DebitMemoPDF parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: debitMemoKey in: path description: 'The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' required: true type: string tags: - Debit Memos responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/POSTMemoPdfResponse' /v1/debitmemos/{debitMemoKey}/post: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nPosts a debit memo to activate it. You can post\ \ debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n" summary: Post a debit memo operationId: PUT_PostDebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018722fa8d73483a number: DM00000001 accountId: 4028ab1f87121698018722fa86dc4823 accountNumber: AN_Test11679919056161 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: '2023-03-27 17:41:03' postedById: e758a64e80f54439913241f9aa537127 status: Posted amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: This is a comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-27 17:40:58' createdById: e758a64e80f54439913241f9aa537127 updatedDate: '2023-03-27 17:41:03' updatedById: e758a64e80f54439913241f9aa537127 cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' name: debitMemoKey required: true /v1/debitmemos/{debitMemoKey}/unpost: put: description: "**Note:** This operation is only available if you have [Invoice\ \ Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\ \ enabled. The Invoice Settlement feature is generally available as of Zuora\ \ Billing Release 296 (March 2021). This feature includes Unapplied Payments,\ \ Credit and Debit Memo, and Invoice Item Settlement. If you want to enable\ \ Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\ \ for more information. \n\nUnposts a debit memo that is in Posted status.\ \ If any credit memo or payment has been applied to a debit memo, you are\ \ not allowed to unpost the debit memo. After a debit memo is unposted, its\ \ status becomes Draft.\n\nYou can unpost debit memos only if you have the\ \ [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n" summary: Unpost a debit memo operationId: PUT_UnpostDebitMemo tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: id: 4028ab1f87121698018722f3b60c375b number: DM00000001 accountId: 4028ab1f87121698018722f3af193744 accountNumber: AN_Test11679918607694 debitMemoDate: '2023-03-27' currency: USD targetDate: null dueDate: '2023-03-27' postedOn: null postedById: null status: Draft amount: 100.0 taxAmount: 0.0 totalTaxExemptAmount: 0.0 balance: 100.0 beAppliedAmount: 0.0 autoPay: true comment: This is a comment referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2023-03-27 17:33:29' createdById: c24f12918d5b45d0b7f9da297b8b7a9d updatedDate: '2023-03-27 17:33:42' updatedById: c24f12918d5b45d0b7f9da297b8b7a9d cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: 4028ab1f87121698018722f3bb0b376b taxStatus: Complete sourceType: Standalone taxMessage: null einvoiceStatus: null einvoiceFileId: null einvoiceErrorCode: null einvoiceErrorMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null organizationLabel: MS US success: true schema: $ref: '#/definitions/GETDebitMemoType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' name: debitMemoKey required: true /v1/debitmemos/{debitMemoKey}/taxationitems: post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates taxation items for a debit memo. summary: Create taxation items for a debit memo operationId: POST_DM_TaxationItems tags: - Debit Memos responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' examples: application/json: taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:27:20' exemptAmount: 0 id: 402890555a7e9791015a87b17cee0076 memoItemId: 402890555a7e9791015a87b082980068 sourceTaxItemId: 402890555a7d4022015a7db254e200c2 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.01 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-06-05' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:27:20' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:27:20' exemptAmount: 0 id: 402890555a7e9791015a87b17cf10077 memoItemId: 402890555a7e9791015a87b082d5006a jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.02 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-06-05' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:27:20' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash success: true schema: $ref: '#/definitions/GETTaxationItemListType' parameters: - $ref: '#/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - type: string in: path name: debitMemoKey description: 'The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. ' required: true - name: body in: body description: '' required: true schema: $ref: '#/definitions/POSTTaxationItemListForDMType' /v1/debitmemos/{debitMemoKey}/einvoice/generate: put: summary: Generate an e-invoice file for a debit memo operationId: PUT_GenerateEInvoiceFileForDebitMemo description: | Generates an e-invoice file for a debit memo. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. tags: - Debit Memos parameters: - $ref: '#/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/parameters/GLOBAL_HEADER_Authorization_OAuth_optional' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - name: debitMemoKey in: path required: true type: string description: 'The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001. ' responses: '200': headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` RateLimit-Limit: type: string description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Remaining: type: number description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' RateLimit-Reset: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. ' Zuora-Request-Id: type: string minLength: 36 maxLength: 36 description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' Zuora-Track-Id: type: string maxLength: 64 description: 'A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: success: true description: '' schema: $ref: '#/definitions/CommonResponseType' /v1/adjustments: post: summary: Create a delivery adjustment operationId: Create_Adjustment description: "Describes how to create one or more delivery adjustments for a\ \ subscription. \n\n**Notes**: \n- The Delivery Adjustments feature is in\ \ the Early Adopter phase. We are actively soliciting feedback from a small\ \ set of early adopters before releasing it as generally available. To manage\ \ and access this feature through the self-service interface, see [Enable\ \ billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)\ \ in the Knowledge Center.\n- This operation supports a partial success scenario:\ \ when at least one eligible delivery adjustment exists for a given time period,\ \ \u201Csuccess = true\u201D as well as eligible delivery adjustments and\ \ ineligible delivery adjustments are returned in the response; only when\ \ no delivery adjustment is eligible, \u201Csuccess=false\u201D is returned.\n" tags: - Delivery Adjustments 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 description: '' required: true schema: $ref: '#/definitions/POSTCreateBillingAdjustmentRequestType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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 specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GETAdjustmentsResponseType' examples: application/json: totalNumberOfDeliveries: 1.0 totalAmount: -5.0 adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 deliveryDate: '2023-02-26' deliveryDay: sunday amount: -5.0 reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: '2023-02-26' creditMemoNumber: CM00000001 status: Billed eligible: true ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null deliveryDate: '2023-02-27' deliveryDay: monday amount: null reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: null status: null eligible: false errorMessage: Subscription does not have a delivery scheduled for this day success: true get: summary: List all delivery adjustments of a subscription operationId: GET_Subscription_Adjustments description: | Describes how to retrieve detailed information about delivery adjustments of a subscription. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. tags: - Delivery Adjustments 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: subscription-number in: query required: true type: string description: 'A subscription number. ' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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 specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GETAdjustmentsBySubscriptionNumberResponseType' examples: application/json: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 deliveryDate: '2023-02-26' deliveryDay: sunday amount: -5.0 reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: '2023-02-26' creditMemoNumber: CM00000001 status: Billed - adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000002 deliveryDate: '2023-02-27' deliveryDay: monday amount: -5.0 reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: '2023-02-27' creditMemoNumber: CM00000002 debitMemoNumber: DM00000002 status: Cancelled success: true /v1/adjustments/{adjustment-key}: get: summary: Retrieve a delivery adjustment operationId: GET_Adjustment description: | Describes how to retrieve detailed information about a delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. tags: - Delivery Adjustments 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: adjustment-key in: path description: The delivery adjustment ID or number to retrieve. required: true type: string responses: 200: headers: Content-Encoding: type: string description: | This header is returned if you specify the `Accept-Encoding: gzip` request header and the response contains over 1000 bytes of data. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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 specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GETAdjustmentByIdResponseType' examples: application/json: adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000001 deliveryDate: '2023-02-26' deliveryDay: sunday amount: -5.0 reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: '2023-02-26' creditMemoNumber: CM00000001 status: Billed /v1/adjustments/preview: post: summary: Preview a delivery adjustment operationId: Preview_Adjustment description: "Describes how to preview delivery adjustments of a subscription.\n\ \n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter\ \ phase. We are actively soliciting feedback from a small set of early adopters\ \ before releasing it as generally available. To manage and access this feature\ \ through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features)\ \ in the Knowledge Center.\n- This operation supports a partial success scenario:\ \ when at least one eligible delivery adjustment exists for a given time period,\ \ \u201Csuccess = true\u201D as well as eligible delivery adjustments and\ \ ineligible delivery adjustments are returned in the response; only when\ \ no delivery adjustment is eligible, \u201Csuccess=false\u201D is returned.\n" tags: - Delivery Adjustments 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 description: '' required: true schema: $ref: '#/definitions/POSTPreviewBillingAdjustmentRequestType' 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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 specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' description: '' schema: $ref: '#/definitions/GETAdjustmentsResponseType' examples: application/json: totalNumberOfDeliveries: 1.0 totalAmount: -5.0 adjustments: - adjustmentId: 'null' adjustmentNumber: 'null' deliveryDate: '2023-02-26' deliveryDay: sunday amount: -5.0 reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: '2023-02-26' creditMemoNumber: null status: null eligible: true ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null deliveryDate: '2023-02-27' deliveryDay: monday amount: null reason: string subscriptionNumber: A-S00000001 chargeNumber: C-00000001 deferredRevenueAccountingCode: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string billingDate: null status: null eligible: false errorMessage: Subscription does not have a delivery scheduled for this day success: true /v1/adjustments/{adjustmentId}/cancel: put: summary: Cancel a delivery adjustment operationId: PUT_CancelAdjustment description: | Describes how to cancel an unbilled delivery adjustment. **Note**: The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center. tags: - Delivery Adjustments 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: adjustmentId in: path description: 'The ID of the delivery adjustment to cancel. ' required: true type: string format: UUID 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. Note that only the following MIME types support gzipped responses: - `application/json` - `application/xml` - `text/html` - `text/csv` - `text/plain` 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 specify a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. ' examples: application/json: debitMemoNumber: DM00000001 success: true description: '' schema: $ref: '#/definitions/GETCancelAdjustmentResponseType' /v1/describe/{object}: get: summary: Describe an object operationId: GET_Describe description: "Provides a reference listing of each object that is available\ \ in your Zuora tenant.\n\nThe information returned by this call is useful\ \ if you are using [CRUD: Create Export](https://developer.zuora.com/api-references/api/operation/Object_POSTExport)\ \ or the [AQuA API](https://knowledgecenter.zuora.com/DC_Developers/T_Aggregate_Query_API)\ \ to create a data source export. See [Export ZOQL](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL)\ \ for more information.\n\n### Response\nThe response contains an XML document\ \ that lists the fields of the specified object. Each of the object's fields\ \ is represented by a `` element in the XML document.\n \nEach ``\ \ element contains the following elements:\n\n| Element | Description\ \ \ \ \ \ \ \ |\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n\ | `` | API name of the field. \ \ \ \ \ \ \ \ |\n| `