openapi: 3.0.0 info: title: API Reference version: '2025-10-10' contact: email: docs@zuora.com description: | Welcome to the v1 API reference for the Zuora Billing, Payments, and Platform! To learn about the common use cases of the Zuora v1 API, check out the [API Tutorials](https://developer.zuora.com/docs/get-started/tutorials/). **Important**: This API Reference only showcases the parameters, fields, and behaviors available for the latest API minor version (`2025-08-12`). For more information about Zuora API versions, see [API versions](https://developer.zuora.com/v1-api-reference/api-versions/) and [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). We recommend that you upgrade to the latest API version to take advantage of the latest Zuora capabilities. For instructions about upgrading the API version, see [API upgrade guide](https://developer.zuora.com/v1-api-reference/api-upgrade-guide/). Try the v1 API in our Postman collection: Run In Postman Some 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/v1-api-reference/older-api/overview/). ### More OpenAPI specification options To support your integration with our OpenAPI specifications, whether using in-house solutions or third-party tools, we provide the following resources: - **Order-to-Cash operations (detailed)**: Download Order-to-Cash OpenAPI spec, which includes full descriptions and examples - **Order-to-Cash operations (compact)**: Download Order-to-Cash Compact OpenAPI spec, which excludes descriptions and code examples. - **Full OpenAPI spec (compact)**: Download Compact OpenAPI Spec, which covers the entire API set without descriptions or samples. If you need a different API specification beyond the options above, contact Zuora Global Support, and we will provide a custom spec tailored to your needs. servers: - url: https://rest.test.zuora.com description: US Developer & Central Sandbox (incl. Test Drive) - url: https://rest.sandbox.na.zuora.com description: US API Sandbox Cloud 1 - url: https://rest.apisandbox.zuora.com description: US API Sandbox Cloud 2 - url: https://rest.na.zuora.com description: US Production Cloud 1 - url: https://rest.zuora.com description: US Production Cloud 2 - url: https://rest.test.eu.zuora.com description: EU Developer & Central Sandbox - url: https://rest.sandbox.eu.zuora.com description: EU API Sandbox - url: https://rest.eu.zuora.com description: EU Production - url: https://rest.test.ap.zuora.com description: APAC Developer & Central Sandbox - url: https://rest.ap.zuora.com description: APAC Production security: - bearerAuth: [] tags: - 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. This section contains the operations that allow you to create, update, get, delete, activate, or deactivate accounting codes in Zuora. name: Accounting Codes - description: | A key step in configuring Finance is to create accounting periods in Zuora to match your company's financial calendar. This 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. name: Accounting Periods - 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 [Retrieve an account](https://developer.zuora.com/v1-api-reference/api/operation/GET_Account/) operation retrieves the basic information of an account, such as bill-to and sold-to contacts, billing and payments setup information, and metrics data for the account. The [Retrieve an account summary](https://developer.zuora.com/v1-api-reference/api/operation/GET_AccountSummary/) operation returns the more detailed information of an account, such as bill-to and sold-to contacts, subscriptions, invoices, payments, and usages associated with this account. name: Accounts - description: | Delivery Adjustments are used to handle end customer delivery complaints for the Delivery Pricing charge model. For more information, see Delivery Adjustments. name: Delivery Adjustments - 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. AQuA enforces the following limits: - 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. - AQuA enforces limits on both the stateful concurrent AQuA jobs and the stateless concurrent AQuA jobs per tenant: - The maximum number of stateful concurrent AQuA jobs per tenant is 50. - The maximum number of stateless concurrent AQuA jobs per tenant is 50. AQuA jobs in the following status are counted towards your concurrent AQuA job limits: - Submitted - Executing Zuora system will reject the subsequent stateful or stateless job requests once the corresponding concurrent job limit is reached. For more information about the Aggregate Query API(AQuA), see Aggregate Query. name: Aggregate Queries - description: | Use the Bill Run call to create ad hoc bill runs and Post, Cancel, Query, and Delete bill runs. For more information about bill runs, see Bill runs. name: Bill Run - description: | Billing documents include invoices, credit memos, and debit memos. **Note**: Credit memos and debit memos are only available if you have the Invoice Settlement feature enabled. name: Billing Documents - 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. **Note**: Credit memo item data is only available if you have the Invoice Settlement feature enabled. name: Billing Preview Run - 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. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant The user will have to provide the client id and secret key from the sou.rce tenant. To understand the known behavior of configuration templates and APIs, see the following sections: [Product Catalog deployment known facts and system behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior) [Product Catalog deployment FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs) [Deployment Manager Known Facts and Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations) name: Configuration Templates - name: Metadata description: | The Metadata API in Zuora promotes a programmatic way to retrieve, compare, and validate metadata within Zuora tenants for performing create and update actions between the source and the target. To use this API for migrating metadata from a source tenant to a destination tenant, you should authenticate using credentials of the source tenant. The user will have to provide the client id and secret key from the source tenant. To understand the known behavior of configuration templates and APIs, see the following sections: [Product Catalog deployment known facts and system behavior](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AE_Known_facts_and_system_behavior) [Product Catalog deployment FAQs](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/CB_Product_Catalog_deployments/AF_Product_Catalog_deployment_FAQs) [Deployment Manager Known Facts and Limitations](https://knowledgecenter.zuora.com/Zuora_Platform/Tenant_Management/Deployment_Manager/C_Deployment_Manager_Limitations) - description: | The Bulk Data API operations allow you to manage bulk data loader services and perform programmatic CRUD (Create, Update, Read/export, Delete) operations. \ To perform data ingestion with a CSV file in Zuora Billing using the Data Loader Bulk Data APIs, see Tutorial for Bulk job API with CSV. For more information, see Process Bulk Job with JSON-lines in Data Loader. name: Bulk Data - description: | Every time a contact is updated a snapshot is taken. name: Contact Snapshots - 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: Contacts - 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: Credit Memos - 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 Event Triggers - description: | With Custom Objects service, you can define custom objects, extending the Zuora data model to accommodate your specific use cases. If 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. 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. Note 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. ### Error handling If 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. name: Custom Object Definitions - description: | With Custom Objects service, you can create, update, delete and find custom object records. If 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. 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. Note 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. ### Error handling If 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. name: Custom Object Records - description: | With Custom Objects service, you can submit a bulk job request to create, update, or delete custom object records in a batch. If 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. 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. Note 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. ### Error handling If 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. name: Custom Object Jobs - 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: Custom Scheduled Events - 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: Data Queries - 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: Debit Memos - 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. All the operations in this section are available only if you have the E-Invoicing feature enabled. name: E-Invoicing - description: | Use invoice schedules to trigger invoice generation processes. For more information about invoice schedules, see Billing Schedule overview. name: Invoice Schedules - description: | Invoices provides information about customers' accounts for invoices, for examples, dates, status, and amounts. For more information about invoices, see Invoice. name: Invoices - 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: Journal Runs - description: | Use mass updater to perform mass actions more easily. For more information about mass updater, see Mass Updater. name: Mass Updater - 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. Zuora notification system processes the events in the same order in which they are triggered. The timing and delivery of notifications can still vary based on factors such as retries, concurrency, and network latency. But Zuora guarantees the best performance possible with the right performance boosters and tuning. 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: Notifications - description: | Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API. You 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. name: OAuth - 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: Operations - description: | Payment methods represents payment method details associated with a customer account. name: Payment Methods - description: | Use payments to process payments, for example, automate recurring payments, manage overpayments, and create refunds. For more information about payments, see Payments. name: Payments - 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: Prepaid with Drawdown - 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: Products - 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. To create a billing document sequence set through the Zuora UI, see Create Billing Document Sequence Sets for more information. name: Sequence Sets - 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: Subscriptions - 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. For more information, see Summary Journal Entries Introduction name: Summary Journal Entries - description: | The Summary Statement feature provides a comprehensive overview of billing activities for each account using HTML templates that compile data like invoices, credit memos, payments, and more. The associated APIs help automate the creation and management of these statements. See Account Summary Statements for more information. name: Summary Statements - 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: Taxation Items - 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. To make this work, usage must be tracked in the system and usage charges must be calculated and invoiced. Usage 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. For more information about working with usage data, see Usage. name: Usage paths: /oauth/token: post: security: [] description: | Creates a bearer token that enables an OAuth client to authenticate with the Zuora REST API. The OAuth client must have been created using the Zuora UI. See [Authentication](https://developer.zuora.com/rest-api/general-concepts/authentication/) for more information. **Note:** When using this operation, do not set any authentication headers such as `Authorization`, `apiAccessKeyId`, or `apiSecretAccessKey`. You should not use this operation to generate a large number of bearer tokens in a short period of time; each token should be used until it expires. If you receive a 429 Too Many Requests response when using this operation, reduce the frequency of requests. This endpoint is rate limited by IP address. For the rate limit information of authentication, see [Rate and concurrent request limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/). operationId: createToken parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Zuora-Entity-Ids in: header required: false description: | An entity ID if you have Multi-entity enabled. The value must be a 36-character UUID that contains hyphens(`-`). If your entity ID is not a valid UUID, convert it to a valid UUID before specifying this parameter. schema: type: string format: uuid example: 11e643f4-a3ee-8bad-b061-0025904c756d requestBody: content: application/x-www-form-urlencoded: schema: properties: client_id: description: | The Client ID of the OAuth client. maxLength: 36 minLength: 36 type: string client_secret: description: | The Client Secret that was displayed when the OAuth client was created. maxLength: 42 type: string grant_type: description: | The OAuth grant type that will be used to generate the token. The value of this parameter must be `client_credentials`. enum: - client_credentials type: string required: - client_id - client_secret - grant_type type: object required: true responses: '200': content: application/json: examples: response: value: access_token: c652cbc0ea384b9f81856a93a2a74538 expires_in: 3599 jti: c652cbc0ea384b9f81856a93a2a74539 scope: user.7c4d5433dc234c369a01b9719ecd059f entity.1a2b7a37-3e7d-4cb3-b0e2-883de9e766cc entity.c92ed977-510c-4c48-9b51-8d5e848671e9 service.echo.read tenant.19 token_type: bearer schema: $ref: '#/components/schemas/tokenResponse' description: OK headers: X-RateLimit-Limit-minute: description: | The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer X-RateLimit-Remaining-minute: description: | The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '429': description: Too Many Requests headers: X-RateLimit-Limit-minute: description: | The rate limit of this operation, in requests per minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer X-RateLimit-Remaining-minute: description: | The number of requests that you may make in the next minute. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: integer Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an OAuth token tags: - OAuth x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=b64e42ba-7e1a-4bc6-9146-5e1b420306b5" --data-urlencode "client_secret=dOFENLWU193EEoEsWjPZrcjLKVr5OrN1HC9Kqg" -d "grant_type=client_credentials" "https://rest.zuora.com/oauth/token" /v1/object/product: post: description: '' operationId: Object_POSTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateProduct' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e03246ae5129 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a product' tags: - Products /v1/object/product/{id}: get: description: Retrieve a specific product. operationId: Object_GETProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: CreatedById: 2c93808457d787030157e02e62af2097 CreatedDate: '2016-10-20T05:42:05.000+02:00' Description: Create product via API_new EffectiveEndDate: '2066-10-20' EffectiveStartDate: '1966-10-20' Id: 2c93808457d787030157e02e7be22210 Name: P_1476934925293_new SKU: API-SKU1476934925293 UpdatedById: 2c93808457d787030157e02e62af2097 UpdatedDate: '2016-10-20T05:42:05.000+02:00' schema: $ref: '#/components/schemas/ProxyGetProduct' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Retrieve a product' tags: - Products put: description: Updates a Product object. operationId: Object_PUTProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyProduct' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e02e7be22210 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Update a product' tags: - Products delete: description: Deletes a specific product. operationId: Object_DELETEProduct parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 2c93808457d787030157e02e7a22220e success: true schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Delete a product' tags: - Products /v1/accounts: post: description: | Creates a customer account with a payment method, a bill-to contact, and optional sold-to and ship-to contacts. 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. This operation is CORS Enabled, so you can use client-side Javascript to invoke the call. ### Notes 1. The account is created in active status. 2. 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. 3. Customer accounts created with this call are automatically be set to Auto Pay. 4. 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. ### Defaults for customerAcceptanceDate and serviceActivationDate Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:------------- | :-----| | 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 | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | This call supports a subset of the functionality of our [Create an order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/) call. For use cases where you create a subscription and a billing account at the same time, we recommend using "Create an order" instead of this call. The Orders call has the following advantages: - Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions. - Allows the creation or modifying of multiple subscriptions in a single order. - Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods. - Orders are treated as atomic transactions. If any part fails, the entire order, subscription, and billing account creation are rolled back. You should use this call if you need to create a standalone billing account, and create orders, subscriptions, standalone invoices, or dynamic usage charges later. There are no deprecation plans for this call and we will continue to support this call for existing users. operationId: POST_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountType' required: true responses: '200': content: application/json: examples: response: value: success: true accountId: 8ad087d2909293cb0190964171da0999 accountNumber: A00000214 billToContactId: 8ad087d2909293cb019096417222099b soldToContactId: 8ad087d2909293cb01909641723e099e schema: $ref: '#/components/schemas/POSTAccountResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an account tags: - Accounts /v1/accounts/{account-key}: delete: description: | Deletes a specific account asynchronously. **Notes and Limitations:** - 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. - 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. - 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. operationId: DELETE_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Pending success: true schema: $ref: '#/components/schemas/DeleteAccountResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an account tags: - Accounts get: 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. operationId: GET_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: basicInfo: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: ff808081298c6e5401298c7a845c007b 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: '' billingAndPayment: additionalEmailAddresses: - contact1@example.com - contact2@example.com autoPay: true billCycleDay: 1 currency: USD defaultPaymentMethodId: 2c93808457d787030157e03220ec4fad invoiceDeliveryPrefsEmail: true invoiceDeliveryPrefsPrint: false paymentMethodCascadingConsent: false paymentGateway: TestGateway paymentTerm: Net 30 einvoiceProfile: businessCategory: B2B businessName: legal business name businessNumber: '20002039' businessNumberSchemeId: '88' enabled: true endpointId: '8992' endpointSchemeId: '88' taxRegisterNumber: TAX393999 metrics: balance: 0 contractedMrr: -900 creditBalance: 0 totalInvoiceBalance: 0 metricsData: - balance: 0 contractedMrr: -900 currency: USD reservedPaymentAmount: 900 totalDebitMemoBalance: 0 totalInvoiceBalance: 0 unappliedCreditMemoAmount: 0 unappliedPaymentAmount: 0 - balance: 0 contractedMrr: -900 currency: EUR reservedPaymentAmount: -900 totalDebitMemoBalance: 0 totalInvoiceBalance: 0 unappliedCreditMemoAmount: 0 unappliedPaymentAmount: 0 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: '' success: true schema: $ref: '#/components/schemas/GETAccountType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an account tags: - Accounts put: 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, Sold To, and Ship To contacts are separate contact entities. However, if you set the `soldToSameAsBillTo` field to `true` when creating an account, the Bill To and Sold To contacts will refer to the same contact entity. As a result, updating either contact will update both. The same behavior applies to the `shipToSameAsBillTo` field and the Ship To contact. In this case, if you want to update only one of the contacts, you must create a new contact and then update the Bill To, Sold To, or Ship To contact to reference the newly created one. operationId: PUT_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an account tags: - Accounts /v1/accounts/{account-key}/payment-methods: get: 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. operationId: GET_AcountPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - 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. in: query name: isDefaultOnly required: false schema: 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. in: query name: isActiveOnly required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: ach: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: null addressLine1: DSDFD addressLine2: '' city: Example City country: United States email: test@test.com phone: '2554444' state: Example State zipCode: '123456' accountKey: 4028839f7ca29000017ca29c1ce8003f bankABACode: '110000000' bankAccountName: Test bankAccountNumber: '********6789' bankAccountType: Checking bankIdentificationNumber: null bankName: Chase createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-10-27 05:32:19' deviceSessionId: null existingMandate: null id: 4028839f7cc14262017cc1bca9eb0008 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-10-27 05:32:19' lastTransactionStatus: Approved mandateInfo: existingMandateStatus: null mandateCreationDate: null mandateId: null mandateReason: null mandateReceivedStatus: null mandateStatus: null mandateUpdateDate: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: ACH updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-10 00:50:12' useDefaultRetryRule: true creditcard: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '123456' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true creditcardreferencetransaction: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: '' addressLine1: '' addressLine2: '' city: '' country: null email: '' phone: null state: '' zipCode: '' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: null cardNumber: null createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-03 22:35:59' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2021 id: 4028839f7ce8c530017ce9725e2c0003 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-03 22:35:59' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null secondTokenId: FGDSDF status: Active tokenId: ABCE totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCardReferenceTransaction updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-03 22:35:59' useDefaultRetryRule: true debitcard: - AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: 1051 E Hillsdale Blvd addressLine2: '' city: Tynan country: United States email: smith@example.com phone: '' state: California zipCode: '45101' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '588888' cardNumber: '************8888' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-01 00:01:52' creditCardType: Electron deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2021 id: 4028839f7cd92a6b017cda4defd00006 ipAddress: null isDefault: false lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-01 00:01:53' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-01 00:01:52' useDefaultRetryRule: true defaultPaymentMethodId: 4028839f7d26a155017d26af16ef0001 paymentGateway: null success: true schema: $ref: '#/components/schemas/GETAccountPaymentMethodType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List payment methods of an account tags: - Accounts /v1/accounts/{account-key}/payment-methods/cascading: get: summary: Retrieve configuration of cascading payment methods for an account description: | Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to retrieve the configuration information for Cascading Payment Method of a specified account, including the cascading consent value and the priority list of payment methods. Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods. operationId: GetAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: consent: true priorities: - paymentMethodId: 2c92c0f95be68649015bf14e001f2760 order: 1 - paymentMethodId: 2c92c0f95be68649015bf14e001f2761 order: 2 - paymentMethodId: 2c92c0f95be68649015bf14e001f2762 order: 3 success: true schema: $ref: '#/components/schemas/GetCascadingPaymentMethodsConfigurationResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Accounts put: summary: Configure cascading payment methods for an account description: | Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method. Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see Cascade payment methods. operationId: PutAccountPaymentMethodCascading parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutCascadingPaymentMethodsConfigurationRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' tags: - Accounts /v1/accounts/{account-key}/payment-methods/default: get: description: |- Retrieves the default payment method of the specified customer account. **Notes:** operationId: GET_AcountDefaultPaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '844000' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active success: true totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true schema: $ref: '#/components/schemas/GETPaymentMethodResponseForAccount' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the default payment method of an account tags: - Accounts /v1/accounts/{account-key}/summary: get: description: | Retrieves detailed information about the specified customer account. The response includes the account information and a summary of the account’s subscriptions, invoices, payments, and usages. ### Notes Returns 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. operationId: GET_AccountSummary parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Account number or account ID. in: path name: account-key required: true schema: type: string - description: Indicate whether to exclude usage information in the response. The default value is `false`. in: query name: excludeUsage required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: basicInfo: accountNumber: A00001115 additionalEmailAddresses: - contact1@example.com - contact2@example.com autoPay: true balance: 0 billCycleDay: 1 currency: USD defaultPaymentMethod: creditCardExpirationMonth: 10 creditCardExpirationYear: 2020 creditCardNumber: '************1111' creditCardType: Visa id: 2c92c8f83dabf9cf013daef12dd303b0 paymentMethodType: CreditCard id: 2c92a0f9391832b10139183e277a0042 invoiceDeliveryPrefsEmail: true invoiceDeliveryPrefsPrint: false lastInvoiceDate: '2013-02-11' lastPaymentAmount: 150248.1 lastPaymentDate: '2013-03-27' name: subscribeCallYan_1 partnerAccount: false paymentMethodCascadingConsent: false status: Active billToContact: address1: 1400 Bridge Pkwy address2: '' city: San Jose country: United States county: '' fax: '' firstName: Cheng id: 2c92a0f9391832b10139183e27940043 lastName: Zou state: California taxRegion: '' workEmail: contact@example.com workPhone: '5555551212' zipCode: '95135' invoices: - amount: 139722.1 balance: 0 dueDate: '2013-02-11' id: 2c92a0953a3fa95d013a407c10a60100 invoiceDate: '2013-02-11' invoiceNumber: INV00000323 status: Posted - amount: 10521 balance: 0 dueDate: '2012-08-11' id: 2c92a09739190dc60139194bcf1b0098 invoiceDate: '2012-08-11' invoiceNumber: INV00000160 status: Posted - amount: 10 balance: 0 dueDate: '2012-08-11' id: 2c92a09539190dbe0139190f42780012 invoiceDate: '2012-08-11' invoiceNumber: INV00000159 status: Posted payments: - effectiveDate: '2013-03-27' id: 2c92c8f83dabf9cf013daf3bfa0305a6 paidInvoices: - appliedPaymentAmount: 5 invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 - appliedPaymentAmount: 139722.1 invoiceId: 2c92a0953a3fa95d013a407c10a60100 invoiceNumber: INV00000323 - appliedPaymentAmount: 10521 invoiceId: 2c92a09739190dc60139194bcf1b0098 invoiceNumber: INV00000160 paymentNumber: P-00000075 paymentType: Electronic status: Processed - effectiveDate: '2012-08-11' id: 2c92a0f9391832b101391922ad5f049d paidInvoices: - appliedPaymentAmount: 5 invoiceId: 2c92a09539190dbe0139190f42780012 invoiceNumber: INV00000159 paymentNumber: P-00000056 paymentType: Electronic status: Processed soldToContact: address1: 278 Bridgeton Circle address2: '' city: San Jose country: United States county: '' fax: '' firstName: Bill id: 2c92a0f9391832b10139183e27940043 lastName: Cho state: California taxRegion: '' workEmail: contact@example.com workPhone: '5555551212' zipCode: '95135' subscriptions: - autoRenew: true id: 2c92c8f83dc4f752013dc72c24ee016d initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 3 status: Active subscriptionNumber: A-S00001081 subscriptionStartDate: '2013-02-01' termEndDate: '2014-02-01' termStartDate: '2013-02-01' termType: TERMED - autoRenew: true id: 2c92c8f83dc4f752013dc72bb85c0127 initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 3 status: Active subscriptionNumber: A-S00001080 subscriptionStartDate: '2013-02-01' termEndDate: '2014-02-01' termStartDate: '2013-02-01' termType: TERMED - autoRenew: false id: 2c92c8f83dc4f752013dc723fdab00d4 initialTerm: 10 ratePlans: - productName: Recurring Charge ratePlanName: QSF_Tier renewalTerm: 4 status: Cancelled subscriptionNumber: A-S00001079 subscriptionStartDate: '2013-02-01' termEndDate: '2014-04-01' termStartDate: '2013-12-01' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db4717ad000ec initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001076 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db3ab6a4d00bc initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001075 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED - autoRenew: false id: 2c92c8f83db0b4b4013db3aa9fbd0090 initialTerm: 12 ratePlans: - productName: Recurring Charge ratePlanName: Month_PerUnit renewalTerm: 3 status: Active subscriptionNumber: A-S00001074 subscriptionStartDate: '2011-02-11' termEndDate: '2012-02-11' termStartDate: '2011-02-11' termType: TERMED success: true usage: - quantity: 10 startDate: 2012-02 unitOfMeasure: UOM - quantity: 10 startDate: 2012-01 unitOfMeasure: UOM schema: $ref: '#/components/schemas/GETAccountSummaryType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an account summary tags: - Accounts /v1/contacts: post: description: | Creates a contact for a specified account. Each account must have at least one contact before it can be saved. You can add a maximum of 2000 contacts to an account. operationId: POST_CreateContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTContactType' required: true responses: '200': content: application/json: examples: response: value: accountId: 6e767220676e6e61206776652075207570 accountNumber: A00000001 address1: 314, Bongora address2: near Tech City city: GHY contactDescription: This is a description for the contact 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 success: true taxRegion: California workEmail: amy.lawrence@zuora.com workPhone: (888) 976-9056 zipCode: '123456' schema: $ref: '#/components/schemas/ContactResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a contact tags: - Contacts /v1/contacts/{contactId}: delete: description: | Deletes a contact. operationId: DELETE_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to delete. in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a contact tags: - Contacts get: description: | Retrieves detailed information about a specific contact. operationId: GET_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to retrieve. in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 72756e2061726e642026206465736572742075 accountNumber: A00000001 address1: 567, Rose Apartment address2: Gate no. 2 city: Seattle contactDescription: This is a description 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 success: true taxRegion: CA workEmail: work.mail@example.com workPhone: '3432' zipCode: '123134' schema: $ref: '#/components/schemas/ContactResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a contact tags: - Contacts put: description: | Updates a contact for a specified account. You can update contacts for cancelled accounts. operationId: PUT_Contact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to update. in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTContactType' required: true responses: '200': content: application/json: examples: response: value: accountId: 6e767220676e6e61206d616b65207520637279 accountNumber: A00000001 address1: new Address address2: near Tech City city: Mumbai contactDescription: This is the new Description 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 success: true taxRegion: California workEmail: amy.lawrence@zuora.com workPhone: (888)976-9056 zipCode: '123134' schema: $ref: '#/components/schemas/ContactResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a contact tags: - Contacts /v1/contacts/{contactId}/transfer: put: description: | This operation transfers contacts of the accounts within the Customer Hierarchy when removing the account. operationId: transferContent parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | The ID of the contact that you want to scrub sensitive data from. in: path name: contactId required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTransferContact' required: true responses: '200': content: application/json: example: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Transfer a contact tags: - Contacts /v1/contacts/{contactId}/scrub: put: description: | Scrubs the sensitive data of a specific contact. You 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. After scrubbing a contact, it is good practice to delete it. Otherwise, it might cause errors in subsequent operations. **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. operationId: PUT_ScrubContact parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the contact that you want to scrub sensitive data from. in: path name: contactId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Scrub a contact tags: - Contacts /v1/contact-snapshots/{contact-snapshot-id}: get: description: | Retrieves detailed information about the snapshot of a contact, either a bill-to contact or sold-to contact. operationId: GET_ContactSnapshot parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID of the contact snapshot to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab. in: path name: contact-snapshot-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: address1: 4th street Custom colony address2: Thoraipakkam city: Chennai contactId: 4028c7628741ebe3018745f2c4123514 country: India county: null description: null fax: 43212 firstName: Pat homePhone: 9877 id: 4028c7628741ebe3018745f2c4133515 lastName: Parker mobilePhone: '1234567890' nickname: this is a nick name otherPhone: '9876543210' otherPhoneType: Work personalEmail: test123@gmail.com postalCode: 123456 state: TN success: true taxRegion: California workEmail: amy.lawrence@zuora.com workPhone: (888)976-9056 schema: $ref: '#/components/schemas/GETContactSnapshotResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a contact snapshot tags: - Contact Snapshots /v1/subscriptions/preview: post: description: | The REST API reference describes how to create a new subscription in preview mode. This call does not require a valid customer account. It can be used to show potential new customers a preview of a subscription with complete details and charges before creating an account, or to let existing customers preview a subscription with all charges before committing. **Notes**: - The response of the Preview Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers. - If you have the Invoice Settlement feature enabled, we recommend that you set the `Zuora-Version` parameter to `207.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error is returned. - Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:-------------| :-----| | 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 | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | operationId: POST_PreviewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionPreviewType' required: true responses: '200': content: application/json: examples: response: value: success: true contractedMrr: 14.99 totalContractedValue: 179.88 amount: 14.99 amountWithoutTax: 14.99 taxAmount: 0 invoiceTargetDate: '2024-07-11' documentDate: '2024-07-11' invoiceItems: - serviceStartDate: '2024-07-01' serviceEndDate: '2024-07-31' chargeAmount: 14.99 taxAmount: 0 chargeDescription: '' chargeName: Monthly Fee productName: Music Service productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 quantity: 1 unitOfMeasure: '' schema: $ref: '#/components/schemas/POSTSubscriptionPreviewResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/preview: post: description: | Describes how to preview an existing subscription to view information about existing and future invoices or credit memos. **Note**: The `Zuora-Version` parameter must be `207.0` or later. operationId: PreviewExistingSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * targetDate * includeExistingDraftDocItems * previewType * taxationItems If you have the Invoice Settlement feature enabled, you need to specify this parameter. Otherwise, an error is returned. in: header name: Zuora-Version required: false schema: type: string - description: Subscription number or ID in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PreviewExistingSubscriptionRequest' required: true responses: '200': content: application/json: example: invoices: - invoiceNumber: Preview Invoice amount: 10 amountWithoutTax: 10 taxAmount: 0 targetDate: '2024-02-01' status: null isFromExistingInvoice: false invoiceItems: - serviceStartDate: '2024-01-01' serviceEndDate: '2024-01-31' amountWithoutTax: 10 taxAmount: 0 chargeDescription: Recurring Flat Fee Pricing chargeName: Recurring_Flat Fee Pricing1628472350306 chargeNumber: C-0000001 productName: P_1628472348863 productRatePlanChargeId: 402881547b216168017b2884182f12e7 processingType: Charge unitPrice: 10 quantity: 1 unitOfMeasure: null creditMemos: - creditMemoNumber: Preview Credit Memo amount: 10 amountWithoutTax: 10 taxAmount: 0 targetDate: '2024-02-01' status: null isFromExistingCreditMemo: false creditMemoItems: - serviceStartDate: '2024-01-01' serviceEndDate: '2024-01-31' amountWithoutTax: 10 taxAmount: 0 chargeDescription: Recurring Flat Fee Pricing chargeName: Recurring_Flat Fee Pricing1628472350306 chargeNumber: C-0000001 productName: P_1628472348863 productRatePlanChargeId: 402881547b216168017b2884182f12e7 processingType: Charge unitPrice: 10 quantity: 1 unitOfMeasure: null success: true schema: $ref: '#/components/schemas/PreviewExistingSubscriptionResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a subscription by subscription key tags: - Subscriptions x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/subscriptions: post: description: | This operation describes how to create a new subscription for an existing customer account. ### Notes If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. Default values for **customerAcceptanceDate** and **serviceActivationDate** are set as follows. This API operation does not support creating a pending subscription. | | serviceActivationDate(SA) specified | serviceActivationDate (SA) NOT specified | | ------------- |:------------- | :-----| | 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 | | customerAcceptanceDate (CA) NOT specified | SA uses value in the request call; CA uses SA as default | SA and CA use CE as default | This call supports a subset of the functionality of our [Create an order](https://developer.zuora.com/v1-api-reference/api/operation/POST_Order/) call. We recommend using "Create an order" instead of this call because the Orders call has the following advantages: - Provides options for managing the entire subscription lifecycle from creation through to cancellation using different order actions. - Allows the creation or modifying of multiple subscriptions in a single order. - Allows a single order to combine both recurring subscription digital goods or services with order line items for physical goods. - Orders are treated as atomic transactions. If any part fails, the entire order and subscription changes are rolled back. This call can be used to create a single subscription and there are no deprecation plans for this call. We will continue to support this call. operationId: POST_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: success: true subscriptionId: 8ad087d290a5e7330190b98577936eaf subscriptionNumber: A-S00000141 contractedMrr: 14.99 totalContractedValue: 179.88 schema: $ref: '#/components/schemas/POSTSubscriptionResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a subscription tags: - Subscriptions /v1/subscriptions/accounts/{account-key}: get: description: | Retrieves all subscriptions associated with the specified account. Zuora only returns the latest version of the subscriptions. Subscription data is returned in reverse chronological order based on `updatedDate`. Note that the rate plans inside the subscriptions are not sorted specifically and are returned in a random order. operationId: GET_SubscriptionsByAccount parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | Possible values are: * an account number * an account ID in: path name: account-key required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate). * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd. in: query name: charge-detail required: false schema: type: string - description: | The date for `charge-detail`. It is only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`. in: query name: as-of-date schema: type: string - description: | When a rate plan charge has multiple segments, the last segment is returned by default. If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to `true`, this charge is excluded from the response; If all the charges under a rate plan are excluded, the rate plan is not returned in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - description: |- The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: subscriptions: - accountId: 8a8082c45aa81b51015ad64396090f5c accountName: ABCD accountNumber: A00002641 autoRenew: true 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: '' contractEffectiveDate: '2017-01-01' contractedMrr: 8.33 contractedNetMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 currency: USD currentTerm: 12 currentTermPeriodType: Month customerAcceptanceDate: '2017-01-01' id: 8a8082c45aa81b51015ad68743ec0fdb initialTerm: 12 initialTermPeriodType: Month invoiceGroupNumber: N-0001 invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c invoiceOwnerAccountName: ABCD invoiceOwnerAccountNumber: A00002641 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a invoiceSeparately: false invoiceTemplateId: 2c9081a03c638994013c63978baf002b invoiceTemplateName: InvoiceTemplateName notes: '' paymentTerm: Net 30 ratePlans: - id: 8a8082c45aa81b51015ad68744030fe3 productId: 8a8082c45aa81b51015ad5a2d07d0e89 productName: ABC productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d productSku: SKU-00000987 contractedNetMrr: 8.33 contractedMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 ratePlanCharges: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Annual billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 8.333333 done: false dtcv: 100 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744160fe4 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: FlatFee mrr: 8.333333 name: Annual Charge number: C-00032238 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744160fe4 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 100 priceChangeOption: NoChange priceIncreasePercentage: null pricingSummary: USD100 processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f quantity: 1 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 100 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - applyDiscountTo: ONETIMERECURRINGUSAGE billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: null chargedThroughDate: null currency: USD description: '' discountAmount: 10 discountApplyDetails: - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 discountClass: VIP Discount discountLevel: subscription discountPercentage: null dmrc: 0 done: false dtcv: 0 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744240fe5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: DiscountFixedAmount mrr: 0 name: Discount-Fixed 10 number: C-00032239 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744240fe5 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: USD10 fixed amount discount processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8 quantity: null segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 0 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - amendedByOrderOn: null applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModelConfiguration: null chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 38.571428571 done: false dtcv: 468 effectiveEndDate: '2026-01-01' effectiveStartDate: '2024-12-31' endDateCondition: Subscription_End id: 4028818386ba85070186bab54f99573d includedUnits: null inputArgumentId: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: Delivery mrr: 38.571428571 name: Delivery Charge number: C-00032240 numberOfDeliveries: 52 numberOfPeriods: null originalChargeId: 4028818386ba85070186bab54f065731 originalOrderDate: '2023-01-01' overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 9 priceChangeOption: null priceIncreasePercentage: null pricingSummary: '' processedThroughDate: null productRatePlanChargeId: 4028818386b61be50186b6293eb30017 quantity: 1 ratingGroup: null segment: 3 smoothingModel: null specificBillingPeriod: null specificEndDate: null subscriptionChargeDeliverySchedule: dayOfMonth: null frequency: Weekly friday: false monday: false monthOfYear: null saturday: false sunday: true thursday: false tuesday: false wednesday: false subscriptionChargeIntervalPricing: - duration: 365 price: 5 sequence: 1 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: 365 price: 7 sequence: 2 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: null price: 9 sequence: 3 subscriptionChargeIntervalPriceTiers: [] type: Infinity tcv: 468 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: RatePlan 1 renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 12 renewalTermPeriodType: Month revision: '1.0' sequenceSetId: 6abcc30846de11e990900242ac1f0003 sequenceSetName: DEFAULT serviceActivationDate: '2017-01-01' soldToContact: 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: '' status: Active subscriptionNumber: A-S00007412 subscriptionStartDate: '2017-01-01' termEndDate: '2018-01-01' termStartDate: '2017-01-01' termType: TERMED totalContractedValue: 100 version: 1 success: true schema: $ref: '#/components/schemas/GETSubscriptionWrapper' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List subscriptions by account key tags: - Subscriptions /v1/subscriptions/{subscription-key}: get: description: | This REST API reference describes how to retrieve detailed information about a specified subscription in the latest version. operationId: GET_SubscriptionsByKey parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Possible values are: * a subscription number * a subscription ID in: path name: subscription-key required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate). * __all-segments__: All the segmented charges. The `ratePlans` > `ratePlanCharges` >`chargeSegments` nested field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment__: Use this value together with `as-of-date={specificDate}`. The segmented charge that is active on a date you specified ((specific date = effectiveStartDate) OR (effectiveStartDate < specific date < effectiveEndDate)) is returned. The format of the date is `yyyy-mm-dd`. in: query name: charge-detail required: false schema: type: string - description: | The date for `charge-detail`. It is only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`. in: query name: as-of-date schema: type: string - description: | When a rate plan charge has multiple segments, the last segment is returned by default. If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to `true`, this charge is excluded from the response; If all the charges under a rate plan are excluded, the rate plan is not returned in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - name: asOfDay description: | The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query schema: type: string - description: 'Retrieves the invoice owner of a subscription. If this parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response. ' in: query name: getInvoiceOwnerDetails schema: type: boolean - description: 'Retrieves the owner of a subscription. If this parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response. ' in: query name: getSubscriptionOwnerDetails schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 8a8082c45aa81b51015ad64396090f5c accountName: ABCD accountNumber: A00002641 accountOwnerDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active summaryStatementTemplateId: null purchaseOrderNumber: '' invoiceOwnerAccountDetails: accountNumber: A00000001 batch: Batch1 communicationProfileId: 303d186840e611df817c002185d714e1 crmId: '' id: 402892c74c9193cd014c91d35b0a0132 invoiceTemplateId: null name: Test notes: '' partnerAccount: false profileNumber: CP-00000012 salesRep: '' sequenceSetId: null status: Active autoRenew: true contractEffectiveDate: '2017-01-01' contractedMrr: 8.33 contractedNetMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 currency: USD currentTerm: 12 currentTermPeriodType: Month customerAcceptanceDate: '2017-01-01' id: 8a8082c45aa81b51015ad68743ec0fdb initialTerm: 12 initialTermPeriodType: Month invoiceGroupNumber: N-0001 invoiceOwnerAccountId: 8a8082c45aa81b51015ad64396090f5c invoiceOwnerAccountName: ABCD invoiceOwnerAccountNumber: A00002641 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a invoiceSeparately: false invoiceTemplateId: 2c9081a03c638994013c63978baf002b invoiceTemplateName: InvoiceTemplateName notes: '' paymentTerm: Net 30 ratePlans: - id: 8a8082c45aa81b51015ad68744030fe3 productId: 8a8082c45aa81b51015ad5a2d07d0e89 productName: ABC productRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d productSku: SKU-00000987 contractedNetMrr: 8.33 contractedMrr: 8.33 asOfDayGrossMrr: 8.33 asOfDayNetMrr: 8.33 netTotalContractedValue: 8.33 ratePlanCharges: - applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Annual billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 8.333333 done: false dtcv: 100 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744160fe4 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: FlatFee mrr: 8.333333 name: Annual Charge number: C-00032238 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744160fe4 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 100 priceChangeOption: NoChange priceIncreasePercentage: null pricingSummary: USD100 processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f quantity: 1 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 100 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - applyDiscountTo: ONETIMERECURRINGUSAGE billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: null chargedThroughDate: null currency: USD description: '' discountAmount: 10 discountApplyDetails: - appliedProductName: ABC appliedProductRatePlanChargeId: 8a8082c45aa81b51015ad5a655c00e8f appliedProductRatePlanChargeName: Annual Charge appliedProductRatePlanId: 8a8082c45aa81b51015ad5a473fb0e8d appliedProductRatePlanName: RatePlan 1 discountClass: VIP Discount discountLevel: subscription discountPercentage: null dmrc: 0 done: false dtcv: 0 effectiveEndDate: '2018-01-01' effectiveStartDate: '2017-01-01' endDateCondition: Subscription_End id: 8a8082c45aa81b51015ad68744240fe5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: DiscountFixedAmount mrr: 0 name: Discount-Fixed 10 number: C-00032239 numberOfPeriods: null originalChargeId: 8a8082c45aa81b51015ad68744240fe5 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: USD10 fixed amount discount processedThroughDate: null productRatePlanChargeId: 8a8082c45aa81b51015ad683bc590fd8 quantity: null segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 0 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 - amendedByOrderOn: null applyDiscountTo: null billingDay: DefaultFromCustomer billingPeriod: Month billingPeriodAlignment: AlignToCharge billingTiming: IN_ADVANCE chargeModelConfiguration: null chargedThroughDate: null currency: USD description: '' discountAmount: null discountApplyDetails: null discountClass: null discountLevel: null discountPercentage: null dmrc: 38.571428571 done: false dtcv: 468 effectiveEndDate: '2026-01-01' effectiveStartDate: '2024-12-31' endDateCondition: Subscription_End id: 4028818386ba85070186bab54f99573d includedUnits: null inputArgumentId: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: Per_Billing_Period model: Delivery mrr: 38.571428571 name: Delivery Charge number: C-00032240 numberOfDeliveries: 52 numberOfPeriods: null originalChargeId: 4028818386ba85070186bab54f065731 originalOrderDate: '2023-01-01' overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: 9 priceChangeOption: null priceIncreasePercentage: null pricingSummary: '' processedThroughDate: null productRatePlanChargeId: 4028818386b61be50186b6293eb30017 quantity: 1 ratingGroup: null segment: 3 smoothingModel: null specificBillingPeriod: null specificEndDate: null subscriptionChargeDeliverySchedule: dayOfMonth: null frequency: Weekly friday: false monday: false monthOfYear: null saturday: false sunday: true thursday: false tuesday: false wednesday: false subscriptionChargeIntervalPricing: - duration: 365 price: 5 sequence: 1 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: 365 price: 7 sequence: 2 subscriptionChargeIntervalPriceTiers: [] type: Day - duration: null price: 9 sequence: 3 subscriptionChargeIntervalPriceTiers: [] type: Infinity tcv: 468 tiers: null triggerDate: null triggerEvent: ContractEffective type: Recurring unusedUnitsCreditRates: null uom: null upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: RatePlan 1 renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 12 renewalTermPeriodType: Month revision: '1.0' sequenceSetId: 6abcc30846de11e990900242ac1f0003 sequenceSetName: DEFAULT serviceActivationDate: '2017-01-01' 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: 2c9081a03c6d7b51013c6d7e46c80a17 lastName: Test mobilePhone: '' nickname: '' otherPhone: '' otherPhoneType: null personalEmail: '' state: '' taxRegion: null workEmail: contact@example.com workPhone: '' zipCode: '' status: Active subscriptionNumber: A-S00007412 subscriptionStartDate: '2017-01-01' success: true termEndDate: '2018-01-01' termStartDate: '2017-01-01' termType: TERMED totalContractedValue: 100 version: 1 schema: $ref: '#/components/schemas/GETSubscriptionByKeyWithSuccess' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a subscription by key tags: - Subscriptions put: description: | Use this call to make the following kinds of changes to a subscription: - Add a note - Change the renewal term or auto-renewal flag - Change the term length or change between evergreen and termed - Add a new product rate plan - Remove an existing subscription rate plan - Change the quantity or price of an existing subscription rate plan - Change rate plans - to replace the existing rate plans in a subscription with other rate plans. Changing rate plans is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing. ### Notes: - The "Update a subscription" call creates a new subscription object that has a new version number and to which the subscription changes are applied. The new subscription object has the same subscription name but a new, different, subscription ID. The `Status` field of the new subscription object will be set to `Active` unless the change applied was a cancelation or suspension in which case the status reflects that. The `Status` field of the originating subscription object changes from `Active` to `Expired`. A status of `Expired` does not imply that the subscription itself has expired or ended, merely that this subscription object is no longer the most recent. - In one request, this call can make: - Up to 9 combined add, update, and remove changes - No more than 1 change to terms & conditions - Updates are performed in the following sequence: 1. First change the notes on the existing subscription, if requested. 2. Then change the terms and conditions, if requested. 3. Then perform the remaining amendments based upon the effective dates specified. If multiple amendments have the same contract-effective dates, then execute adds before updates, and updates before removes. - The update operation is atomic. If any of the updates fails, the entire operation is rolled back. - The response of the Update Subscription call is based on the REST API minor version you set in the request header. The response structure might be different if you use different minor version numbers. - If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. ### Override a Tiered Price There are two ways you override a tiered price: - Override a specific tier number. For example: `tiers[{tier:1,price:8},{tier:2,price:6}]` - Override the entire tier structure. For example: `tiers[{tier:1,price:8,startingUnit:1,endingUnit:100,priceFormat:"FlatFee"}, {tier:2,price:6,startingUnit:101,priceFormat:"FlatFee"}]` If you just override a specific tier, do not include the `startingUnit` field in the request. operationId: PUT_Subscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | Subscription number or ID. ID can be the latest version or any history version of ID. * To make sure you update the last version of the subscription, use one of the following operations to retrieve the last version of ID: * [List subscriptions by account key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByAccount) * [Retrieve a subscription by key](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKey) by using the subscription number as the subscription-key * If you want to use any history version of ID, the `STABLE_ID_PUBLIC_API` permission must be enabled. Submit a request at [Zuora Global Support](http://support.zuora.com/) to enable the permission. To retrieve a history version of ID, use the [Retrieve a subscription by key and version](https://developer.zuora.com/api-references/api/operation/GET_SubscriptionsByKeyAndVersion) operation. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: subscriptionId: 4028bb83510f8ed7015114a503cf0373 success: true totalDeltaMrr: 100 totalDeltaTcv: 4867.7419355 schema: $ref: '#/components/schemas/PUTSubscriptionResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/versions/{version}: get: description: | This REST API reference describes how to retrieve detailed information about a specified subscription in a specified version. When you create a subscription amendment, you create a new version of the subscription. You can use this method to retrieve information about a subscription in any version. operationId: GET_SubscriptionsByKeyAndVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Subscription number. For example, A-S00000135. in: path name: subscription-key required: true schema: type: string - description: | Subscription version. For example, 1. in: path name: version required: true schema: type: string - description: | The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this field to track segment charges. Possible values are: * __last-segment__: (Default) The last rate plan charge on the subscription, that is, the last segmented rate plan charge with the maximum start and end dates. * __current-segment__: The segmented charge that is active on today’s date (effectiveStartDate <= today’s date <= effectiveEndDate). * __all-segments__: All the segmented charges. The `chargeSegments` field is returned in the response. The `chargeSegments` field contains an array of the charge information for all the charge segments. * __specific-segment&as-of-date=date__: The segmented charge that is active on a date you specified (effectiveStartDate <= specific date < effectiveEndDate). The format of the date is yyyy-mm-dd. in: query name: charge-detail required: false schema: type: string - description: | The date for `charge-detail`. It is only available when `charge-detail` is `specific-segment`. The date should be in the format `YYYY-MM-DD`. in: query name: as-of-date schema: type: string - description: | When a rate plan charge has multiple segments, the last segment is returned by default. If this charge has been removed before the start date of the last segment (the latest one), with this parameter set to `true`, this charge is excluded from the response; If all the charges under a rate plan are excluded, the rate plan is not returned in the response. The default value is `false`. in: query name: exclude-rate-plans-with-no-charges required: false schema: type: boolean - description: |2- If the `getDetailedMetrics` field is `true`, `contractedNetMrr`, `asOfDayGrossMrr`, `asOfDayNetMrr`, and `netTotalContractedValue` will be in the response. The default value is `false`. in: query name: getDetailedMetrics schema: type: boolean default: false - description: |- The date for detailed metrics. Only available when `getDetailedMetrics` is `true`. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 2c9081a03c63c94c013c66688a2c00bf accountName: RestAPI accountNumber: RestAPI autoRenew: false contractEffectiveDate: '2012-02-01' contractedMrr: 26.67 contractedNetMrr: 26.67 asOfDayGrossMrr: 26.67 asOfDayNetMrr: 26.67 netTotalContractedValue: 26.67 currency: USD currentTerm: 12 currentTermPeriodType: Week customerAcceptanceDate: '2012-02-01' id: 2c9081a03c63c94c013c687b864e0195 initialTermPeriodType: Week invoiceGroupNumber: N-0001 invoiceScheduleId: ec6f0d5dc8af451ab95343fb3c588c1a notes: '' ratePlans: - id: 2c9081a03c63c94c013c687b868901a4 productId: 2c9081a03c63c94c013c66499ef0001b productName: OneTime productRatePlanId: 2c9081a03c63c94c013c665102e5003a productSku: SKU-00000022 contractedNetMrr: 26.67 contractedMrr: 26.67 asOfDayGrossMrr: 26.67 asOfDayNetMrr: 26.67 netTotalContractedValue: 26.67 ratePlanCharges: - applyDiscountTo: null billingDay: null billingPeriod: null billingPeriodAlignment: null billingTiming: null chargedThroughDate: '2012-02-02' currency: USD description: '' discountAmount: null discountLevel: null discountPercentage: null dmrc: null done: true dtcv: 24 effectiveEndDate: '2012-02-02' effectiveStartDate: '2012-02-01' endDateCondition: One_Time id: 2c9081a03c63c94c013c687b868901a5 includedUnits: null invoiceScheduleId: 8a8082c45aa81b51015ad68744240ff5 listPriceBase: null model: Tiered mrr: null name: OT_Tiered number: C-00000010 numberOfPeriods: null originalChargeId: 2c9081a03c63c94c013c687a92d70175 overageCalculationOption: null overagePrice: null overageUnusedUnitsCreditOption: null price: null priceChangeOption: null priceIncreasePercentage: null pricingSummary: '0 to 10 Each: USD20 flat fee; 11 Each or more: USD4/Each' processedThroughDate: '2012-02-02' productRatePlanChargeId: 2c9081a03c63c94c013c6651d677003c quantity: 11 segment: 1 smoothingModel: null specificBillingPeriod: null specificEndDate: null tcv: 24 tiers: - endingUnit: 10 price: 20 priceFormat: FlatFee startingUnit: 0 tier: 1 - endingUnit: null price: 4 priceFormat: PerUnit startingUnit: 11 tier: 2 triggerDate: null triggerEvent: ContractEffective type: OneTime unusedUnitsCreditRates: null uom: Each upToPeriods: null upToPeriodsType: null usageRecordRatingOption: null version: 1 ratePlanName: OT_Tiered renewalSetting: RENEW_WITH_SPECIFIC_TERM renewalTerm: 0 renewalTermPeriodType: Week revision: '1.0' serviceActivationDate: '2012-02-01' status: Active subscriptionNumber: A-S00000004 subscriptionStartDate: '2012-02-01' success: true termEndDate: '2013-02-01' termStartDate: '2012-02-01' termType: TERMED totalContractedValue: 404 version: 1 schema: $ref: '#/components/schemas/GETSubscriptionTypeWithSuccess' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a subscription by key and version tags: - Subscriptions /v1/subscriptions/{subscription-key}/renew: put: description: | Renews a termed subscription using existing renewal terms. When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as `SubscriptionTerm`, a new charge segment is generated for the new term. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_RenewSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Subscription number or ID in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTRenewSubscriptionType' required: true responses: '200': content: application/json: examples: response: value: subscriptionId: 2c92c8f83dcbd8b1013dcce0f09100a5 success: true termEndDate: '2014-05-01' termStartDate: '2014-02-01' schema: $ref: '#/components/schemas/PUTRenewSubscriptionResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Renew a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/cancel: put: description: | This REST API reference describes how to cancel an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_CancelSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Subscription number or ID. Subscription status must be `Active`. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSubscriptionCancellationType' required: true responses: '200': content: application/json: examples: response: value: cancelledDate: '2019-05-31' invoiceId: 8a8082c453cd2a620153e426c7eb78b3 subscriptionId: 8a8082c453cd2a620154efc7bba0350e success: true totalDeltaMrr: 0 totalDeltaTcv: -703.2258065 schema: $ref: '#/components/schemas/POSTSubscriptionCancellationResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/resume: put: description: | This REST API reference describes how to resume a suspended subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_ResumeSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Subscription number or ID. Subscription status must be Suspended. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionResumeType' required: true responses: '200': content: application/json: examples: response: value: success: true subscriptionId: 6429c37b5a392e093172e68779c24021 resumeDate: '2024-11-01' termEndDate: '2025-01-13' totalDeltaTcv: 167.070913965 schema: $ref: '#/components/schemas/PUTSubscriptionResumeResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resume a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/suspend: put: description: | This REST API reference describes how to suspend an active subscription. **Note**: If you have the Invoice Settlement feature enabled, it is best practice to set the `Zuora-Version` parameter to `211.0` or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version). Otherwise, an error occurs. operationId: PUT_SuspendSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: Subscription number or ID. Subscription status must be Active. in: path name: subscription-key required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionSuspendType' required: true responses: '200': content: application/json: examples: response: value: success: true subscriptionId: 8ad0937890e7fca00190fd3ff7ca7f08 suspendDate: '2024-07-28' resumeDate: null termEndDate: '2025-07-22' totalDeltaTcv: -176.978709679 schema: $ref: '#/components/schemas/PUTSubscriptionSuspendResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Suspend a subscription tags: - Subscriptions /v1/subscriptions/{subscription-key}/delete: put: description: | This REST API reference describes how to delete a subscription of the specified subscription number. operationId: PUT_DeleteSubscription parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Subscription number in: path name: subscription-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTDeleteSubscriptionResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a subscription by number tags: - Subscriptions /v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields: put: description: | Updates the custom fields of a specified subscription version. operationId: PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The subscription number to be updated. in: path name: subscriptionNumber required: true schema: format: string type: string - description: The subscription version to be updated. in: path name: version required: true schema: format: string type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSubscriptionPatchSpecificVersionRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update subscription custom fields of a subscription version tags: - Subscriptions /v1/subscriptions/subscription-metrics: get: description: | Lists subscription metrics for the subscriptions that you specify by subscription numbers. operationId: GetMetricsBySubscriptionNumbers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The date for the metrics. The date should be in the format `YYYY-MM-DD`. The default value is the current date. in: query name: asOfDay schema: type: string - description: The subscription numbers of existing subscriptions. in: query name: subscriptionNumbers[] required: true schema: type: array items: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: subscriptionMetrics: - subscriptionNumber: A-S00000008 contractedMrr: 100 contractedNetMrr: 100 asOfDayGrossMrr: 100 asOfDayNetMrr: 100 netTotalContractedValue: 100 totalContractedValue: 100 - subscriptionNumber: A-S00000009 contractedMrr: 100 contractedNetMrr: 100 asOfDayGrossMrr: 100 asOfDayNetMrr: 100 netTotalContractedValue: 100 totalContractedValue: 100 success: true schema: $ref: '#/components/schemas/GETMetricsBySubscriptionNumbersResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List subscription metrics by subscription numbers tags: - Subscriptions /v1/ppdd/reverse-rollover: post: description: | This REST API reference describes how to manually reverse fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not work if the associated prepayment charge has rollover enabled. operationId: POST_ReverseRollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTReverseRolloverRequestType' required: true responses: '200': content: application/json: examples: response: value: message: Reverse rollover is done reverseRolloverFundCount: 1 success: true schema: $ref: '#/components/schemas/POSTReverseRolloverResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse fund rollover tags: - Prepaid with Drawdown /v1/ppdd/rollover: post: description: | Prepaid with Drawdown Rollover enables you to transfer the accumulative carryover of your customers’ prepaid balance funds to the following validity period when using Prepaid with Drawdown. This REST API reference describes how to manually trigger fund rollover from source validity period to destination validity period. There are no path or query parameters. **Note**: This API will not work if rollover is enabled in the associated prepayment charge. If you want to trigger rollover automatically, see Create prepayment charge with rollover for more information. operationId: POST_Rollover parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTriggerRolloverRequestType' required: true responses: '200': content: application/json: examples: response: value: message: Rollover is done rolloverFundCount: 1 success: true schema: $ref: '#/components/schemas/POSTTriggerRolloverResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Trigger fund rollover tags: - Prepaid with Drawdown /v1/prepaid-balance-funds/deplete: post: description: 'Depleting a prepaid balance fund enables you to expire the remaining balance, which can be recognized by revenue. When an expiry request is received, the remaining fund balance is reduced to zero, and the related objects like PrepaidBalance, ValidityPeriodSummary, PrepaidBalanceTransaction, and DailyConsumption will be updated. ' operationId: DepleteFunds parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTDepleteFundRequestType' required: true responses: '200': content: application/json: examples: response: value: fundIds: - fundId: 4028818c8d3ade79018d3ae1048a5e10 status: success message: The fund object is depleted. - fundId: 4028818c8d3ade79018d3ae1048a5ef8 status: success message: The fund object is depleted. schema: $ref: '#/components/schemas/POSTDepleteFundResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Deplete funds tags: - Prepaid with Drawdown /v1/usage: post: description: | This REST API reference describes how to post or import usage data for one or more accounts in the CSV format. There are no path or query parameters. The data is uploaded using the HTTP multipart/form-data POST method and applied to the user's tenant. ### How this REST API Call Works The content of the uploaded usage file must follow the format used by the UI import tool. It must be a comma-separated (CSV) file with a corresponding .csv extension. The length of the file name must not exceed 50 characters. The file size must not exceed 4MB. See [Downloading the Usage Template](https://knowledgecenter.zuora.com/CB_Billing/J_Billing_Operations/Usage/C_Import_Usage_Data#Downloading_the_Usage_Template) to learn about how to download the usage file template. At the completion of the upload, before the file contents are actually being processed, the API returns a response containing the byte count of the received file and a URL for checking the status of the import process. Of the five possible results displayed at that URL (Pending, Processing, Completed, Canceled, and Failed) only a Completed status indicates that the import was successful. The operation is atomic; if any record fails, the file is rejected. In that case, the entire import is rolled back and all stored data is returned to its original state. To view the actual import status, enter the resulting status URL from the checkImportStatus response using a tool such as POSTMAN. This additional step provides more information about why the import has failed. To manage the information after a successful upload, use the web-based UI. ### Usage File Format The usage file uses the following headings: | Heading | Description | Required | |-----------------|--------|----------| | ACCOUNT_ID | Enter the account number, e.g., the default account number, such as A00000001, or your custom account number. Although this field is labeled as Account_Id, it is not the actual Account ID nor Account Name. | Yes | | UOM | Enter the unit of measure. This must match the UOM for the usage. | Yes | | QTY | Enter the quantity. | Yes | | STARTDATE | Enter the start date of the usage. This date determines the invoice item service period the associated usage is billed to. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`. | Yes | | ENDDATE | Enter the end date of the usage. This is not used in calculations for usage billing and is optional. Date format is based on locale of the current user. Default date format: `MM/DD/YYYY`.

**Note:** The value of this column is optional, but the column header is required.

| No | | PRODUCT_RATE_PLAN_CHARGE_ID | Enter a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record.

**Note:** The value of this column is optional, but the column header is required. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `146` or higher. Otherwise, an error occurs.

| No | | SUBSCRIPTION_ID | Enter the subscription number or subscription name. If you created the subscription in the Zuora application, Zuora created a number automatically in a format similar to A-S00000001. If you do not provide a value for this field, the associated usage will be added to all subscriptions for the specified Account that use this Unit Of Measure. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the Subscription or Charge ID in each usage record.

**Note:** The value of this column is optional, but the column header is required.

| No | | CHARGE_ID | Enter the charge number (not the charge name). You can see the charge ID, e.g., C-00000001, when you add your rate plan to your subscription and view your individual charges. If your Accounts can have multiple subscriptions and you do not want double or triple counting of usage, you must specify the specific Subscription or Charge ID in each usage record. This field is related to the Charge Number on the subscription rate plan.

**Note:** The value of this column is optional, but the column header is required.

| No | | DESCRIPTION | Enter a description for the charge. | No | | UNIQUE_KEY | Enter a specific identifier for this usage record. **Note**: This Heading is supported by the following features: Prepaid with Drawdown, and Unbilled Usage. See Upload usage record with unique key for more information. | No | operationId: POST_Usage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The usage data to import. The supported formats are excel, csv, and zip. format: binary type: string required: - file type: object required: true responses: '200': content: application/json: examples: response: value: checkImportStatus: /v1/usage/2c92c8f83dcbd8b1013dcce1159900cc/status size: 316 success: true schema: $ref: '#/components/schemas/POSTUsageResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a usage file tags: - Usage x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@UsageData.csv" "https://rest.zuora.com/v1/usage" /v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail: get: description: | Use this REST API operation to retrieve the usage rate detail for an invoice item to understand how the total amount is calculated. The information is the same as the Rate Detail presented on [PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). **Notes and limitations:** - Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model. - Do not support invoices in `Cancelled` or `Reversed` status. - Do not support Active rating. - In terms of rating group options, only the [Usage rating by billing period](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/Usage_Rating_by_Group#Usage_rating_by_billing_period) is supported. - Do not support [On-demand usage rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). - Tax calculation is not involved. operationId: GET_Usage_Rate_Detail_By_Invoice_Item parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`. Available through Data Source export. in: path name: invoice-item-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: amountWithoutTax: 58 chargeNumber: C-00000001 invoiceId: 402880e57f725d85017f7267c44c0028 invoiceItemId: 402880e57f725d85017f7267c4ad002b invoiceNumber: INV00000007 listPrice: | Tier / From / To / List Price / Price Format 1 / 0 / 9 / 0.00 / Per Unit 2 / 10 / 20 / 1.00 / Per Unit 3 / 21 / 30 / 2.00 / Flat Fee 4 / 31 / / 3.00 / Per Unit quantity: 45 rateDetail: |- Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00 Tier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00 Tier 3: 21-30, $2.00 Flat Fee Tier 4: >=31, 15 Each(s) x $3.00/Each = $45.00 Total = $58.00 servicePeriod: 03/01/2022-03/31/2022 uom: Each success: true schema: $ref: '#/components/schemas/GETUsageRateDetailWrapper' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve usage rate detail for an invoice item tags: - Usage /v1/object/usage: post: description: Creates a usage record. operationId: Object_POSTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_X_Zuora_WSDL_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a usage record' tags: - Usage /v1/object/usage/{id}: delete: description: Deletes a usage record. operationId: Object_DELETEUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ProxyDeleteResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Delete a usage record' tags: - Usage get: description: Retrieve a usage record. operationId: Object_GETUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object fields to return in: query name: fields required: false schema: type: string - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: AccountId: 2c92c0f956bc8fb40156d502fc3718b1 AccountNumber: A00000030 ChargeId: 2c92c0f956bc8fcb0156d5039e275aa9 ChargeNumber: C-00000229 CreatedById: 2c92c0f958fffd7d015914aeefc71a5d CreatedDate: '2019-07-18T15:36:43.000+08:00' Description: test Id: 2c92c0f86bf50ca0016c040309316ca4 Quantity: 9 RbeStatus: Pending SourceType: API StartDateTime: '2017-12-01T23:41:36.000+08:00' SubmissionDateTime: '2019-07-18T15:36:43.000+08:00' SubscriptionId: 2c92c0f956bc8fcb0156d5039e0a5aa0 SubscriptionNumber: A-S00000100 UOM: Each UpdatedById: 2c92c0f958fffd7d015914aeefc71a5d UpdatedDate: '2019-07-18T15:36:43.000+08:00' schema: $ref: '#/components/schemas/ProxyGetUsage' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '404': content: application/json: examples: response: value: done: true records: {} size: 0 schema: $ref: '#/components/schemas/ProxyNoDataResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Retrieve a usage record' tags: - Usage put: description: Updates a usage record. operationId: Object_PUTUsage parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Object id in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyModifyUsage' required: true responses: '200': content: application/json: examples: response: value: Id: 8ad08ae29085a77b0190908bfdd67abb Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Update a usage record' tags: - Usage /v1/adjustments: get: 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. operationId: GET_Subscription_Adjustments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | A subscription number. in: query name: subscription-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 - adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000002 amount: -5 billingDate: '2023-02-27' chargeNumber: C-00000001 creditMemoNumber: CM00000002 debitMemoNumber: DM00000002 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Cancelled subscriptionNumber: A-S00000001 success: true schema: $ref: '#/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all delivery adjustments of a subscription tags: - Delivery Adjustments post: description: | Describes how to create one or more delivery adjustments for a subscription. **Notes**: - 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. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Create_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 4028818886a2149b0186a237d0ff003b adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/preview: post: description: | Describes how to preview delivery adjustments of a subscription. **Notes**: - 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. - This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “success = true” as well as eligible delivery adjustments and ineligible delivery adjustments are returned in the response; only when no delivery adjustment is eligible, “success=false” is returned. operationId: Preview_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPreviewBillingAdjustmentRequestType' required: true responses: '200': content: application/json: examples: response: value: adjustments: - adjustmentId: 'null' adjustmentNumber: 'null' amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: null deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday eligible: true reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 ineligibleAdjustments: - adjustmentId: null adjustmentNumber: null amount: null billingDate: null chargeNumber: C-00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-27' deliveryDay: monday eligible: false errorMessage: Subscription does not have a delivery scheduled for this day reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: null subscriptionNumber: A-S00000001 success: true totalAmount: -5 totalNumberOfDeliveries: 1 schema: $ref: '#/components/schemas/GETAdjustmentsResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Preview a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustment-key}: get: 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. operationId: GET_Adjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The delivery adjustment ID or number to retrieve. in: path name: adjustment-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: adjustmentId: 4028818886a2149b0186a2404f67003c adjustmentNumber: ADJ-00000001 amount: -5 billingDate: '2023-02-26' chargeNumber: C-00000001 creditMemoNumber: CM00000001 deferredRevenueAccountingCode: string deliveryDate: '2023-02-26' deliveryDay: sunday reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string status: Billed subscriptionNumber: A-S00000001 schema: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a delivery adjustment tags: - Delivery Adjustments /v1/adjustments/{adjustmentId}/cancel: put: 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. operationId: PUT_CancelAdjustment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the delivery adjustment to cancel. in: path name: adjustmentId required: true schema: format: UUID type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CancelBillingAdjustmentRequest' required: true responses: '200': content: application/json: examples: response: value: debitMemoNumber: DM00000001 success: true schema: $ref: '#/components/schemas/GETCancelAdjustmentResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a delivery adjustment tags: - Delivery Adjustments /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. To retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. You can use query parameters to restrict the data returned in the response. Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted - /billing-documents?accountNumber=A00000001&sort=+documentDate - /billing-documents?accountNumber=A00000001&status=Posted operationId: GET_BillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - 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. in: query name: accountId required: false schema: format: uuid type: string - 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. in: query name: accountNumber required: false schema: format: uuid type: string - 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. in: query name: documentDate required: false schema: format: date type: string - description: | The status of the billing document. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error type: string - 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. If you do not specify any sortable field, the response data is sorted by the `documentDate` field in descending order. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - documentDate - documentType Examples: - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &sort=+documentDate,-documentType - /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1 &status=Posted&sort=+documentDate&page=2&pageSize=15 in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: documents: - accountId: 4028905f5e4feb38bbb50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-10-01' documentNumber: INV-0000001 documentType: Invoice id: 4028905f5e4jjj015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb38b111b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-09-01' documentNumber: CM-0000001 documentType: CreditMemo id: 4028905f5e4jbbb015e50af9aa002d1 status: Posted currency: USD - accountId: 4028905f5e4feb3833b50af9aa002d1 accountNumber: A00000001 amount: 100 balance: 90 documentDate: '2017-07-01' documentNumber: DM-0000001 documentType: DebitMemo id: 4028905f5e4jccc015e50af9aa002d1 status: Posted currency: USD success: true schema: $ref: '#/components/schemas/BillingDocumentQueryResponseElementType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List billing documents for an account tags: - Billing Documents x-code-samples: - label: Curl lang: 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. After 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). **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: POST_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/POSTBillingDocumentFilesDeletionJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a job to hard delete billing document files tags: - Billing Documents /v1/accounts/billing-documents/files/deletion-jobs/{jobId}: get: description: | Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts. **Note**: This operation can be used only if you have the Billing user permission "Hard Delete Billing Document Files" enabled. operationId: GET_BillingDocumentFilesDeletionJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c. in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 2c92c8f83dc4f752013dc72c24ee016c status: Pending success: true schema: $ref: '#/components/schemas/GETBillingDocumentFilesDeletionJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a job of hard deleting billing document files tags: - Billing Documents /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. operationId: POST_GenerateBillingDocuments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostGenerateBillingDocumentType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 8ad084db909fae930190a121c84957ff creditMemos: [] success: true schema: $ref: '#/components/schemas/GenerateBillingDocumentResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate billing documents by account ID tags: - Billing Documents /v1/invoices: post: description: | Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invoice** and at least one of the **Create Standalone Invoice With Product Catalog** or **Create Standalone Invoice Without Product Catalog** user permissions. See Billing Roles for more information. operationId: POST_StandaloneInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff invoiceNumber: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 amount: 100 amountWithoutTax: 100 discount: 0 invoiceDate: '2024-07-30' dueDate: '2024-08-29' autoPay: false comments: null status: Draft taxAmount: 0 taxExemptAmount: 0 transferredToAccounting: null sourceType: Standalone billToContactId: null soldToContactId: null templateId: null paymentTerm: null sequenceSetId: null adjustmentAmount: 0 balance: 100 billToContactSnapshotId: null creditMemoAmount: 0 includesOneTime: true includesRecurring: true includesUsage: true lastEmailSentDate: null paymentAmount: 0 postedBy: null postedDate: null refundAmount: 0 soldToContactSnapshotId: null source: API sourceId: null targetDate: null taxMessage: null taxStatus: Complete createdById: b243314d594646d3b2651aeedd4be47e createdDate: '2024-07-11 02:31:04' updatedById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:31:04' billRunId: null currency: USD invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/PostInvoiceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a standalone invoice tags: - Invoices put: description: | Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices ### Limitations - You can update a maximum of 50 invoices by one call. operationId: PUT_BatchUpdateInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutBatchInvoiceType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update invoices tags: - Invoices /v1/invoices/batch: post: description: | Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers. To use this operation, you must have the **Modify Invoice** and at least one of the **Create Standalone Invoice With Product Catalog** or **Create Standalone Invoice Without Product Catalog** user permissions. See Billing Roles for more information. ### Limitations This operation has the following limitations: * You can create a maximum of 50 invoices in one request. * You can create a maximum of 1,000 invoice items in one request. operationId: POST_StandaloneInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBatchInvoicesType' required: true responses: '200': content: application/json: examples: response: value: invoices: - IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860005 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' - objectIndex: 1 processId: CA037C0B8C5B0682 reasons: - code: 58490020 message: No account is found with accountId ff8080817cda56fa017cda87aaa2071f. success: false success: true schema: $ref: '#/components/schemas/PostBatchInvoiceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create standalone invoices tags: - Invoices /v1/invoices/bulk-post: post: description: | Posts multiple invoices. You can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices. operationId: POST_PostInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoicesBatchPostType' required: true responses: '200': content: application/json: examples: response: value: invoices: - id: 402890555a7e9791015a7f15fe440123 success: true - id: 402890555a7e9791015a7f15fe44013a success: true - id: ff808081804f25b001804f2d8971079f processId: F3D4DAF98E6CE569 reasons: - code: 59210020 message: Only invoices with Draft status can be posted. success: false success: true schema: $ref: '#/components/schemas/InvoicesBatchPostResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post invoices tags: - Invoices /v1/invoices/pdf-status: get: description: 'Retrieves the PDF generation statuses of a batch of invoices. ' operationId: GetInvoicePdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: The IDs or numbers of the invoices separated by commas. For example - `?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001`. A maximum of 50 keys can be entered in this field. in: query name: invoiceKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: invoiceFiles: - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - invoiceId: 2c98908a904dfc2601904e6e14090241 invoiceNumber: INV00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - invoiceId: 513935bb9dd905e6129dd9b231687992 invoiceNumber: INV00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetInvoicePdfStatusBatchResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of invoices tags: - Invoices x-accepts: application/json /v1/invoices/{invoiceKey}: delete: description: | Deletes a specific invoice. Whether to delete an invoice synchronously or asynchronously depends on the number of invoice items contained in the invoice. By default, if an invoice contains less than 100 items, the invoice is deleted synchronously. Otherwise, the invoice is deleted asynchronously. If you want to change the threshold, submit a request at Zuora Global Support. operationId: DELETE_DeleteInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 40288ae9600808280160081dc9c13f15 jobId: 40288ae9600808280160081db1533506 jobStatus: Completed success: true schema: $ref: '#/components/schemas/DeleteInvoiceResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice tags: - Invoices get: description: | Retrieves a specific invoice. operationId: Get_GetInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: IntegrationId__NS: string IntegrationStatus__NS: string SyncDate__NS: string accountId: 4028818484f483d20184f4f7efc40001 adjustmentAmount: 0 amount: 700 amountWithoutTax: 700 autoPay: true balance: 700 billRunId: 4028818484f483d20184f50064950035 billToContactSnapshotId: 402881e522cf4f9b0122cf5d82860010 comments: '' complexity__c: Middle createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2022-12-08 19:49:16' currency: USD description__c: description discount: 0 dueDate: '2022-11-30' id: 4028818484f483d20184f5006b97003f includesOneTime: true includesRecurring: true includesUsage: true invoiceDate: '2022-10-31' invoiceGroupNumber: N-0001 invoiceNumber: INV00000001 lastEmailSentDate: '2022-12-08 19:51:16' paymentAmount: 0 postedBy: 402881e522cf4f9b0122cf5d82860002 postedDate: '2022-12-09' refundAmount: 0 sequenceSetId: 402881e522cf4f9b0122cf5d82860009 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860011 source: BillRun sourceId: BR-00000001 sourceType: Subscription status: Posted success: true targetDate: '2022-10-31' transferredToAccounting: string updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2022-12-08 19:51:23' schema: $ref: '#/components/schemas/PostInvoiceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice tags: - Invoices put: description: | Updates a specific invoice. The following tutorials demonstrate how to use this operation: - Add and delete invoice items of draft standalone invoices - Edit due dates of draft standalone invoices - Edit invoice item prices and custom fields of draft standalone invoices operationId: PUT_UpdateInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutInvoiceType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad084db909fae930190a121c84957ff number: INV00000155 accountId: 8ad09be48db5aba7018db604776d4854 invoiceDate: '2024-07-30' currency: USD targetDate: null dueDate: '2024-08-29' postedOn: null postedById: null status: Draft amount: 105 taxAmount: 0 totalTaxExemptAmount: 0 balance: 105 discount: 0 comment: null autoPay: false transferredToAccounting: false creditBalanceAdjustmentAmount: 0 createdDate: '2024-07-11 02:31:04' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-11 02:43:45' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null success: true schema: $ref: '#/components/schemas/PutInvoiceResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice tags: - Invoices /v1/invoices/{invoiceKey}/application-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. If you are in Zuora version 341, this operation will return only processed payments applied to the invoices. If you are in the Zuora version less than 341, this operation behavior remains the same and returns all payments associated with the invoice regardless of the payment status. Retrieves information about the payments or credit memos that are applied to a specified invoice. operationId: GET_InvoiceApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetInvoiceApplicationPartCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/emails: post: description: | Sends a posted invoice to the specified email addresses manually. ### Notes - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information. - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostInvoiceEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email an invoice tags: - Invoices /v1/invoices/{invoiceKey}/files: get: description: | Retrieves the information about all PDF files of a specified invoice. Invoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. You can use the [Query](https://developer.zuora.com/api-references/api/operation/Action_POSTquery) action to get the latest PDF file, for example: `"select Body from Invoice where Id = '2c93808457d787030157e0324aea5158'"`. See [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information. operationId: GET_InvoiceFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: invoiceFiles: - id: 2c98901f62d7d83d0162d7facec2262f pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d versionNumber: 1524041954479 - id: 2c98901f62d7d83d0162d7f4a9792629 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f4a95c2627 versionNumber: 1524041551946 - id: 2c98901f62d7d83d0162d7f491ea2626 pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7f490f22624 versionNumber: 1524041544112 success: true schema: $ref: '#/components/schemas/GETInvoiceFilesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of an invoice tags: - Invoices post: description: | Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status. To use this operation, you must enable the Modify Invoice permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one invoice. operationId: POST_UploadFileForInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the invoice. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a2 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for an invoice tags: - Invoices x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@InvoiceFile.pdf" "https://rest.zuora.com/v1/invoices/2c92c8955bd63cc1015bd7c151af02ab/files" /v1/invoices/{invoiceKey}/items: get: description: | Retrieves the information about all items of a specified invoice. operationId: GET_InvoiceItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: invoiceItems: - appliedToItemId: null balance: 21.1 chargeAmount: 21.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 2c92c0f9511f56b2015126814af832d2 chargeName: Annual Fee chargeType: Recurring description: '' excludeItemBillingFromRevenueAccounting: true id: 2c92c095511f5b4401512682dd017989 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge productName: TeamCollab Enterprise quantity: 1 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: 2c92c0f9511f56b2015126814ad532cc subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 2.11 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 2.11 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 21.1 - appliedToItemId: 2c92c095511f5b4401512682dd017989 chargeAmount: -2.1 chargeDate: '2015-11-20 19:53:00' chargeDescription: '' chargeId: 1b3dede652fa47db833a83be55d850a5 chargeName: Discount chargeType: OneTime description: '' excludeItemBillingFromRevenueAccounting: true id: 3e28d61d442f433797e268e2b7c11eeb invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Discount productName: TeamCollab Enterprise quantity: 0 serviceEndDate: '2015-11-30' serviceStartDate: '2015-11-20' soldToContactId: 2c92c0f9511f56b2015126814ad532cd soldToContactSnapshotId: 2c92c0f9511f56b2015126814ad532cd sourceItemType: SubscriptionComponent subscriptionId: c2d9a5768db440cbbf2709a55c614bed subscriptionName: A-S00000004 taxAmount: 0 taxationItems: data: - balance: 0.21 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce6eeb0ffe jurisdiction: County locationCode: 000-1 name: taxName paymentAmount: 0 taxAmount: 0.21 taxCode: TAXCODE-1 taxCodeDescription: null taxDate: '2015-11-20' taxRate: 0.1 taxRateDescription: '' taxRateType: Percentage unitOfMeasure: '' unitPrice: 10 success: true schema: $ref: '#/components/schemas/GETInvoiceItemsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all items of an invoice tags: - Invoices /v1/invoices/{invoiceKey}/items/{itemId}/taxation-items: get: description: | Retrieves information about the taxation items of a specific invoice item. operationId: GET_TaxationItemsOfInvoiceItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001. in: path name: invoiceKey required: true schema: type: string - description: | The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef. in: path name: itemId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce84e3102c jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee - balance: 10 creditAmount: 0 exemptAmount: 0 id: 2c98901a68ff26800168ffce85d6102e jurisdiction: test locationCode: code - 001 name: test paymentAmount: 0 taxAmount: 10 taxCode: taxcode taxCodeDescription: description taxDate: '2019-02-18' taxRate: 2 taxRateDescription: test taxRateType: FlatFee success: true schema: $ref: '#/components/schemas/GETInvoiceTaxationItemsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of an invoice item tags: - Invoices /v1/invoices/{invoiceKey}/reverse: 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. Reverses a posted invoice. The reversal operation is performed asynchronously when the invoice contains more than 2,000 items in total. **Restrictions** You are not allowed to reverse an invoice if any of the following restrictions is met: * Payments and credit memos are applied to the invoice. * The invoice is split. * The invoice is not in Posted status. * The total amount of the invoice is less than 0 (a negative invoice). * Using Tax Connector for Extension Platform to calculate taxes. * An invoice contains more than 50,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information. operationId: PUT_ReverseInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseInvoiceType' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseInvoiceResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse an invoice tags: - Invoices /v1/invoices/{invoiceKey}/taxation-items: post: description: | Creates taxation items for an invoice. operationId: POST_INV_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemList' required: true responses: '200': content: application/json: examples: response: value: success: true taxationItems: - createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:08:43' exemptAmount: 0 financeInformation: accountsReceivableAccountingCode: Check accountsReceivableAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 invoiceItemId: 402890555a7e9791015a879f064d0055 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxMode: TaxExclusive taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for an invoice tags: - Invoices /v1/invoices/{invoiceKey}/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. Writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero. If you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance. **Restrictions**: You cannot write off an invoice if any of the following restrictions is met: * The balance of an invoice has been changed before Invoice Settlement is enabled. For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice. * An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information. operationId: PUT_WriteOffInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffInvoiceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off an invoice tags: - Invoices /v1/credit-memos: 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 all credit memos. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If 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`. Examples: - /v1/credit-memos?status=Posted - /v1/credit-memos?referredInvoiceId=null&status=Draft - /v1/credit-memos?status=Posted&type=External&sort=+number operationId: GET_CreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `autoApplyUponPosting` field. in: query name: autoApplyUponPosting required: false schema: type: boolean - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `creditMemoDate` field. in: query name: creditMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `excludeFromAutoApplyRules` field. in: query name: excludeFromAutoApplyRules required: false schema: type: boolean - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `sourceId` field. in: query name: sourceId required: false schema: type: string - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `transferredToAccounting` field. in: query name: transferredToAccounting required: false schema: enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string - description: | This parameter filters the response based on the `unappliedAmount` field. in: query name: unappliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - 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. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by credit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - accountId - amount - appliedAmount - createdById - createdDate - creditMemoDate - number - referredInvoiceId - refundAmount - status - targetDate - taxAmount - totalTaxExemptAmount - transferredToAccounting - unappliedAmount - updatedDate Examples: - /v1/credit-memos?sort=+number - /v1/credit-memos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: creditmemos: - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 23 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:39:30' creditMemoDate: '2017-05-05' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 2c92c8f95bd63b94015bd7c39289112e invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7c395e90023 number: CM00000002 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: BillRun sourceId: BR-00000024 sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 23 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:39:30' - accountId: 2c92c8f95bd63b98015bd7ab09ef0926 accountNumber: A00000001 amount: 10 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 2c92c8f95b79c9ad015b80614273052c createdDate: '2017-05-05 01:15:23' creditMemoDate: '2017-05-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 2c92c8f95bd63b9d015bd7ad7fe206f9 invoiceGroupNumber: N-0001 latestPDFFileId: 2c92c8955bd63b6c015bd7ad8921001d number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 2c92c8955bd63cc1015bd7c151af02ab refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 10 updatedById: 2c92c8f95b79c9ad015b80614273052c updatedDate: '2017-05-05 01:15:24' success: true schema: $ref: '#/components/schemas/GETCreditMemoCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memos tags: - Credit Memos 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 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. When 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. You 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. operationId: POST_CreditMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad08f0091698a7a01916e70df165b3b number: CM00000010 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: null source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Correcting invoice error createdDate: '2024-08-19 23:19:36' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:19:36' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from a charge tags: - Credit Memos /v1/credit-memos/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. Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges. The 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. You 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. Zero-amount memo items are supported in the following scenarios: - 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. - 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. operationId: POST_CreateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create credit memos tags: - Credit Memos put: description: | **Notes:** - 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. - 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. Updates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. 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. operationId: PUT_UpdateCreditMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkCreditMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: ff8080817fe9d7b9017fe9e5234d04cb accountNumber: A00000001 amount: 100 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: test createdById: ff8080817fe9d7b9017fe9e41732030e createdDate: '2022-04-02 18:49:47' creditMemoDate: '2022-04-02' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: ff8080817fe9d7b9017fe9e5382f04f5 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000001 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: ff8080817fe9d7b9017fe9e5317f04e0 refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromInvoice sourceId: null sourceType: Invoice status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 100 updatedById: ff8080817fe9d7b9017fe9e41732030e updatedDate: '2022-04-02 18:49:47' - id: ff8080817fe9d7b9017fe9e41732030f objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id. success: false success: true schema: $ref: '#/components/schemas/BulkCreditMemosResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update credit memos tags: - Credit Memos /v1/credit-memos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of credit memos. operationId: Get_CreditMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the credit memos separated by commas. For example - `?creditMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,CM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: creditMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: creditMemoFiles: - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - creditMemoId: 2c98908a904dfc2601904e6e14090241 creditMemoNumber: CM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - creditMemoId: 514936bb7dd014e6230dd0c342798103 creditMemoNumber: CM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetCreditMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of credit memos tags: - Credit Memos x-accepts: application/json /v1/credit-memos/{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. Retrieves information about the taxation items of a specific credit memo item. operationId: GET_TaxationItemsOfCreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - 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). in: path name: cmitemid required: true schema: type: string - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - appliedAmount: 0 exemptAmount: 10 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 2c98901a68ff2680016903216a271a67 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 refundAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage unappliedAmount: 10 success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfCreditMemoItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a credit memo item tags: - Credit Memos /v1/credit-memos/{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. Write 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. 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. operationId: PUT_WriteOffCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoWriteOff' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 4028905f5a87c0ff015a87e49e6b0062 success: true schema: $ref: '#/components/schemas/PUTCreditMemoWriteOffResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}: 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. Deletes a credit memo. Only credit memos with the Cancelled status can be deleted. You 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. operationId: DELETE_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a credit memo tags: - Credit Memos 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 credit memo. For a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo). operationId: GET_CreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a879f07fb005e number: CM00000012 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo tags: - Credit Memos put: description: | **Notes:** - 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. - You 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. Updates 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. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_UpdateCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e637b19583f number: CM00000008 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: null postedOn: null status: Draft amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 14.99 refundAmount: 0 appliedAmount: 0 comment: Details about this Credit Memo source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 23:04:59' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 23:05:55' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a credit memo tags: - Credit Memos /v1/credit-memos/{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. Applies a posted credit memo to one or more invoices and debit memos. You 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. When 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. If the limit is hit, you can follow the following instructions: - 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. - 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. - 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. If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items + number of debit memo items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: PUT_ApplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad081dd91698b2801916e5a84b65653 number: CM00000007 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 currency: USD creditMemoDate: '2024-08-19' targetDate: null postedById: 8ad09fc28193c189018194da28be74ba postedOn: '2024-08-19 22:55:11' status: Posted amount: 14.99 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 3.99 refundAmount: 0 appliedAmount: 11 comment: '' source: AdhocFromPrpc sourceId: null referredInvoiceId: null reasonCode: Ad hoc credit createdDate: '2024-08-19 22:55:11' createdById: 8ad09fc28193c189018194da28be74ba updatedDate: '2024-08-19 22:59:54' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null latestPDFFileId: ac1ebc24569sd transferredToAccounting: 'No' excludeFromAutoApplyRules: true autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo tags: - Credit Memos /v1/credit-memos/{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. Cancels a credit memo. Only credit memos with the Draft status can be cancelled. You 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. operationId: PUT_CancelCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 2020 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: 402881e522cf4f9b0122cf5d82860002 cancelledOn: '2017-09-03 19:59:07' comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 15:31:10' creditMemoDate: '2017-10-17' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a87d7f5015a88c7a6830022 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a88c7a7a2002a number: CM00000015 postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null refundAmount: 0 reversed: false sequenceSetId: null source: AdhocFromPrpc sourceId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 2020 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 15:36:57' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a credit memo tags: - Credit Memos /v1/credit-memos/{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. Sends a posted credit memo to the specified email addresses manually. ### Notes - 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. - 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. - 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: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCreditMemoEmailRequestType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/files: 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. Uploads an externally generated PDF file for a credit memo that is in Draft or Posted status. To 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. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one credit memo. operationId: POST_UploadFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the credit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a4 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a credit memo tags: - Credit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreditMemoFile.pdf" "https://rest.zuora.com/v1/credit-memos/402890555a7e9791015a879f064a0054/files" get: description: | Retrieves the information about all PDF files of a specified credit memo. Credit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_CreditMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: creditMemoFiles: - id: 8a90a24f8e128020018e12cf610f03f9 pdfFileUrl: /v1/files/8a90a24f8e128020018e12cf610903f8 versionNumber: 1709712563443 - id: 8a90b5148c6d127b018c6d1e3c6e022e pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e3c68022d versionNumber: 1702637739555 success: true schema: $ref: '#/components/schemas/GETCreditMemoFilesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a credit memo tags: - Credit Memos /v1/credit-memos/{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. Retrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If 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`. Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100 - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate operationId: GET_CreditMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - 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. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - amount - appliedAmount - createdById - createdDate - id - refundAmount - serviceEndDate - serviceStartDate - sku - skuName - sourceItemId - subscriptionId - updatedById - updatedDate Examples: - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 0 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012e50085 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: - appliedAmount: 0 exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7e9791015a87a072880062 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX refundAmount: 0 sourceTaxItemId: null 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 unappliedAmount: 0.1 unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' - amount: 2 amountWithoutTax: 2 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: null deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f06610056 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bd0038 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 2 unitOfMeasure: Each unitPrice: 2 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:07:10' success: true schema: $ref: '#/components/schemas/GETCreditMemoItemsListType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List credit memo items tags: - Credit Memos /v1/credit-memos/{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. operationId: GET_CreditMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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). in: path name: cmitemid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedAmount: 0 appliedToItemId: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditFromItemId: 402880e97a56f30b017a574012f00086 creditFromItemSource: CreditMemoItem excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Check deferredRevenueAccountingCodeType: null onAccountAccountingCode: null onAccountAccountingCodeType: null recognizedRevenueAccountingCode: null recognizedRevenueAccountingCodeType: null id: 402890555a7e9791015a879f064d0055 invoiceScheduleId: 402881e522cf4f9b0122cf5d82860005 invoiceScheduleItemId: 402881e522cf4f9b0122cf5d82860006 numberOfDeliveries: 1 processingType: Charge quantity: 1 refundAmount: 0 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000001 skuName: New Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7e9791015a7f1756bc0037 sourceItemType: InvoiceDetail subscriptionId: 402890d25bec1155015bec35cc7c0bc7 success: true taxMode: TaxExclusive taxationItems: data: [] unappliedAmount: 1 unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:08:43' schema: $ref: '#/components/schemas/GETCreditMemoItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo item tags: - Credit Memos /v1/credit-memos/{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. Retrieves 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. operationId: GET_CreditMemoParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: parts: - amount: 3.66 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 13:21:55' debitMemoId: null id: 4028905f5a890526015a8d77adea0029 invoiceId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 13:21:55' success: true schema: $ref: '#/components/schemas/GETCreditMemoPartsCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all parts of a credit memo tags: - Credit Memos /v1/credit-memos/{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. Retrieves 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. A fully refunded credit memo does not contain any credit memo part. operationId: GET_CreditMemoPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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). in: path name: partid required: true schema: type: string - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-02 14:00:21' debitMemoId: null id: 4028905f5a890526015a8d9adeb30059 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 success: true updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-02 14:00:21' schema: $ref: '#/components/schemas/GETCreditMemoPartType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a credit memo part tags: - Credit Memos /v1/credit-memos/{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. Creates 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. 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_CreditMemoPDF parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a credit memo PDF file tags: - Credit Memos /v1/credit-memos/{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. Posts 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). operationId: PUT_PostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/refund: 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. Refunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. 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. When you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000. For a use case of this operation, see [Refund processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing). operationId: POST_RefundCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostNonRefRefundType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad0937890e7fca00190e8c290d46fad number: R-00000001 status: Processed type: Electronic methodType: CreditCard accountId: 8ad09be48db5aba7018db604776d4854 amount: 10 refundDate: '2024-07-25' comment: null paymentMethodId: 8ad084db90a5e73b0190c02783f552fa paymentMethodSnapshotId: 8ad0937890e7fca00190e8c290b86fab paymentId: null paymentNumber: null creditMemoId: 8ad0835290c4bb2f0190d9955e414e62 reasonCode: null gatewayId: 2c92c0f972bc6aa90172bc77ccaf379a paymentGatewayNumber: null gatewayResponse: This transaction has been approved by Test gateway. gatewayResponseCode: approve gatewayState: Submitted markedForSubmissionOn: null referenceId: '70028533' secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: '2024-07-25 00:19:43' settledOn: null cancelledOn: null createdDate: '2024-07-25 00:19:43' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-25 00:19:43' updatedById: b243314d594646d3b2651aeedd4be47e refundTransactionTime: '2024-07-25 00:19:43' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: Accounts Receivable unappliedPaymentAccountingCodeType: AccountsReceivable transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETRefundCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/reverse: 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. 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. operationId: PUT_ReverseCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PutReverseCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PutReverseCreditMemoResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reverse a credit memo tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/taxation-items: 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. operationId: POST_CM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForCMType' required: true responses: '200': content: application/json: examples: response: value: taxationItems: - createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-15 14:41:04' exemptAmount: 0 id: 8ad0980c932a209d01932e8dcbf83bc8 memoItemId: 8ad086fa932a0b5401932e82ab1f1fb3 invoiceItemId: 8ad086fa932a0b5401932e82a3e5b211 sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: STATE TAX taxAmount: 0.5 applicableTaxUnRounded: 0.5 country: null taxCode: ServiceTaxCode taxCodeDescription: null taxDate: '2024-11-15' taxRate: 0.05 taxMode: TaxExclusive taxRateDescription: null taxRateType: Percentage updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-15 14:41:04' financeInformation: salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable accountsReceivableAccountingCode: Accounts Receivable accountsReceivableAccountingCodeType: AccountsReceivable success: true schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a credit memo tags: - Credit Memos /v1/credit-memos/{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. Unapplies 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. 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. When 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. If the limit is hit, you can follow the following instructions: - 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. - 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. - 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. - 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. - When unapplying a credit memo, the total number of the credit memo's item parts must be less than or equal to 1,000. Otherwise, the operation would fail and an error message would pop up. When you see this error, you can try using the Unapply a credit memo API as an alternative. Similarly, make sure that all the requirements listed in the API reference are met. operationId: PUT_UnapplyCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyCreditMemoType' required: true responses: '200': content: application/json: examples: response: value: id: 8a90aac892dc8c3a0192dce41af10077 number: CM00000619 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 currency: USD creditMemoDate: '2024-10-30' targetDate: null postedById: 2c92c8f95e2d6ebb015e325df48e02da postedOn: '2024-10-30 18:06:30' status: Posted amount: 15 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 1 refundAmount: 0 appliedAmount: 14 comment: '' source: AdhocFromInvoice sourceId: null referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7 reasonCode: Correcting invoice error createdDate: '2024-10-30 18:06:29' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-10-30 18:08:37' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Invoice eInvoiceStatus: Failed eInvoiceErrorCode: IntegrationError eInvoiceErrorMessage: Input string was null. eInvoiceFileId: null taxMessage: null billToContactId: null billToContactSnapshotId: 8a90b4488e7d5c0f018e7dbef1f900c9 sequenceSetId: null invoiceGroupNumber: null revenueImpacting: 'Yes' success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo tags: - Credit Memos /v1/credit-memos/{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. Unposts 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. You 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). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 402890555a7e9791015a7f15fe44001c accountNumber: A00000001 amount: 3.1 appliedAmount: 0 autoApplyUponPosting: false billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:07:10' creditMemoDate: '2017-03-01' currency: USD einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing excludeFromAutoApplyRules: false id: 402890555a7e9791015a879f064a0054 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: CM00000012 postedById: 402881e522cf4f9b0122cf5d82860002 postedOn: '2017-03-01 14:28:06' reasonCode: Correcting invoice error referredInvoiceId: 402890555a7e9791015a7f1756aa0035 refundAmount: 0 reversed: false sequenceSetId: null source: API sourceId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0.1 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' unappliedAmount: 3.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:28:06' schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a credit memo tags: - Credit Memos /v1/credit-memos/invoice/{invoiceKey}: 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 an ad-hoc credit memo from an invoice. You 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. For a use case of this operation, see [Create credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo). Zero-amount memo items are supported in the following scenarios: - 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. - 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. operationId: POST_CreditMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8a90e4a792d82d8c0192dbda90671d66 number: CM00000618 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 currency: USD creditMemoDate: '2024-10-30' targetDate: null postedById: null postedOn: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 unappliedAmount: 10 refundAmount: 0 appliedAmount: 0 comment: null source: AdhocFromInvoice sourceId: null referredInvoiceId: 8a90d7a892d82d920192dbcb314501c7 reasonCode: Correcting invoice error createdDate: '2024-10-30 13:16:27' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-10-30 13:16:27' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null latestPDFFileId: null transferredToAccounting: 'No' excludeFromAutoApplyRules: false autoApplyUponPosting: false reversed: false taxStatus: Complete sourceType: Invoice eInvoiceStatus: null eInvoiceErrorCode: null eInvoiceErrorMessage: null eInvoiceFileId: null taxMessage: null billToContactId: null billToContactSnapshotId: null sequenceSetId: null invoiceGroupNumber: null revenueImpacting: 'Yes' success: true schema: $ref: '#/components/schemas/GETCreditMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a credit memo from an invoice tags: - Credit Memos /v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}: 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 Async Credit Memo Unapply job. operationId: getUnapplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a. in: path name: unapplyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: example: id: 8a92ade496140e830196148cd0af000a status: Processed operationType: AsyncCreditMemoUnapply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/apply-async-jobs/{applyAsyncJobId}: 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 Async Credit Memo Apply job. operationId: getApplyCreditMemoAsyncJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001. in: path name: applyAsyncJobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' responses: '200': content: application/json: example: id: 8a92ade496140e830196141f6cfa0001 status: Processed operationType: AsyncCreditMemoApply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an async unapply credit memo job by ID tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/apply-async: 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. Asynchronously applies a posted credit memo to one or more invoices You can apply a credit memo to 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. When 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 300,000. The maximum number of invoices that you can specify in the request is 1,000 If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: (number of invoice items) * number of credit memo items Otherwise, the First In First Out rule will be used instead of the Proration rule. operationId: applyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncApplyCreditMemoRequest' required: true responses: '200': content: application/json: example: id: 402881e522cf4f9b0122cf5d82860002 status: Pending operationType: AsyncCreditMemoApply referenceId: 4028905f5a890526015a8d73f73d0015 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a credit memo aysnchronously tags: - Credit Memos /v1/credit-memos/{creditMemoKey}/unapply-async: 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. Asynchronously Unapplies an applied credit memo from one or more invoices. The full applied amount from invoices is transferred into the unapplied amount of the credit memo. You can unapply 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) When 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 300,000. The maximum number of invoices that you can specify in the request is 1,000 operationId: unapplyCreditMemoAsync parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: | The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/AsyncUnapplyCreditMemoRequest' required: true responses: '200': content: application/json: example: id: 8a92ade496140e830196148cd0af000a status: Pending operationType: AsyncCreditMemoUnapply referenceId: 8a8082e65b27f6c3015ba45ff82c7172 referenceType: CreditMemo error: null success: true schema: $ref: '#/components/schemas/InvoiceSettlementAsyncJobResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a credit memo asynchronously tags: - Credit Memos /v1/debit-memos: 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 all debit memos associated with all customer accounts. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If 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`. Examples: - /v1/debit-memos?status=Posted - /v1/debit-memos?referredInvoiceId=null&status=Draft - /v1/debit-memos?status=Posted&type=External&sort=+number operationId: GET_DebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `accountNumber` field. in: query name: accountNumber required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `balance` field. in: query name: balance required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `debitMemoDate` field. in: query name: debitMemoDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `dueDate` field. in: query name: dueDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `referredInvoiceId` field. in: query name: referredInvoiceId required: false schema: type: string - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string - description: | This parameter filters the response based on the `targetDate` field. in: query name: targetDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `taxAmount` field. in: query name: taxAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `totalTaxExemptAmount` field. in: query name: totalTaxExemptAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - 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. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by debit memo number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - debitMemoDate - targetDate - dueDate - amount - taxAmount - totalTaxExemptAmount - balance - beAppliedAmount - referredInvoiceId - createdDate - createdById - updatedDate - updatedById Examples: - /v1/debit-memos?sort=+number - /v1/debit-memos?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: debitmemos: - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466484 amount: 50 autoPay: true balance: 50 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:24:14' currency: USD debitMemoDate: '2017-10-17' dueDate: '2017-11-16' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a892f2ba10057 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a892f2c5c0060 number: DM00000006 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:24:14' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 0.01 autoPay: true balance: 0.01 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: the comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' currency: USD debitMemoDate: '2017-11-30' dueDate: '2017-12-30' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a89251edc0045 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000003 paymentTerm: null postedById: null postedOn: null reasonCode: Charge Dispute referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.01 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' - accountId: 402890555a7d4022015a7dabf5f60088 accountNumber: AN_1679649466488 amount: 9 autoPay: true balance: 9 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a87d7f5015a8919e4fe002e invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a87d7f5015a8919e95d003a number: DM00000002 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: 402890555a7d4022015a7dadb3b300a4 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 8 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' - accountId: 402890555a7e9791015a7f15fe44001c accountNumber: AN_1679649466684 amount: 8.02 autoPay: true balance: 8.02 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: '' createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 10:26:16' currency: USD debitMemoDate: '2017-03-01' dueDate: '2017-03-31' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 402890555a7e9791015a87b082940067 invoiceGroupNumber: N-0001 latestPDFFileId: 402890555a7e9791015a87b083f00072 number: DM00000001 paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: 402890555a7e9791015a7f1756aa0035 sequenceSetId: null sourceType: Standalone status: Draft targetDate: null taxAmount: 0.02 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 10:45:03' success: true schema: $ref: '#/components/schemas/GETDebitMemoCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memos tags: - Debit Memos 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 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. When 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. You 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. operationId: POST_DebitMemoFromPrpc parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromChargeRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad093789169a0c001916e6be7cf7113 number: DM00000002 accountId: 8ad09be48db5aba7018db604776d4854 accountNumber: A00000097 debitMemoDate: '2024-08-19' currency: USD targetDate: null dueDate: '2024-09-18' postedOn: null postedById: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 balance: 10 beAppliedAmount: 0 autoPay: true comment: null referredInvoiceId: null transferredToAccounting: 'No' reasonCode: Correcting invoice error createdDate: '2024-08-19 23:14:11' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-08-19 23:14:11' updatedById: b243314d594646d3b2651aeedd4be47e cancelledOn: null cancelledById: null referredCreditMemoId: 1a2b3c4d5e6f latestPDFFileId: ac1ebc24569sd taxStatus: Complete sourceType: Standalone taxMessage: null billToContactId: null billToContactSnapshotId: null paymentTerm: null sequenceSetId: null invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from a charge tags: - Debit Memos 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. Updates the due date for multiple debit memos in one single request. This 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. operationId: PUT_UpdateDebitMemosDueDates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBatchDebitMemosRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update due dates for debit memos tags: - Debit Memos /v1/debit-memos/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. Creates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. - If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices. - If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges. The 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. You 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. operationId: POST_CreateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018712fef63e33cb accountNumber: AN_Test11679650911374 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 3e2bcd869cea43eeb00d7a20cc1cb72b createdDate: '2023-03-24 15:12:01' currency: USD debitMemoDate: '2023-03-24' dueDate: '2023-03-24' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018712ff1b0633e2 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 3e2bcd869cea43eeb00d7a20cc1cb72b updatedDate: '2023-03-24 15:12:01' - objectIndex: 1 processId: 0356073CB721291A reasons: - code: 50000040 message: Cannot find a Invoice instance with id test. success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create debit memos tags: - Debit Memos put: description: | **Notes:** - 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. - You 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. Updates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request. Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. The 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. operationId: PUT_UpdateDebitMemos parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBulkDebitMemosRequestType' required: true responses: '200': content: application/json: examples: response: value: memos: - accountId: 4028ab1f87121698018726851cc765ee accountNumber: AN_Test11679978470016 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: new comment123 createdById: aff81dbb5dd846868685592640363b5b createdDate: '2023-03-28 10:11:45' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f8712169801872685a5f46605 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: aff81dbb5dd846868685592640363b5b updatedDate: '2023-03-28 10:12:37' - id: 2c98907562482a8301624b9c0a1a0056 objectIndex: 1 processId: string reasons: - code: string message: string success: false success: true schema: $ref: '#/components/schemas/BulkDebitMemosResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update debit memos tags: - Debit Memos /v1/debit-memos/pdf-status: get: description: | Retrieves the PDF generation statuses of a batch of debit memos. operationId: Get_DebitMemoPdfStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: 'The IDs or numbers of the debit memos separated by commas. For example - `?debitMemoKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,DM0000001`. A maximum of 50 keys can be entered in this field. ' in: query name: debitMemoKeys required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: debitMemoFiles: - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:32:19' updatedOn: '2024-01-01 11:32:19' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - debitMemoId: 2c98908a904dfc2601904e6e14090241 debitMemoNumber: DM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - debitMemoId: 623935cc6ee105f7341ee1d453809214 debitMemoNumber: DM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true schema: $ref: '#/components/schemas/GetDebitMemoPdfStatusBatchResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '50000020' message: Credit memo key is required success: false schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: example: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string '403': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve the PDF file generation status of debit memos tags: - Debit Memos x-accepts: application/json /v1/debit-memos/{debitMemoId}/application-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. Retrieves information about the payments or credit memos that are applied to a specified debit memo. If you use the Zuora version 341.0 or a [later available version](https://developer.zuora.com/v1-api-reference/api-versions/), this operation will return only processed payments applied to the debit memos. For Zuora versions earlier than 341.0, it returns all payments associated with the debit memo regardless of the payment status. operationId: GET_DebitMemoApplicationParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: applicationParts: - appliedAmount: 22 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:42:16' creditMemoId: 4028905f60a165a50160b4f632ff023d paymentId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:42:16' - appliedAmount: 11 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2018-01-02 11:41:38' creditMemoId: null paymentId: 4028905f60a165a50160b4f5d5cb0229 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2018-01-02 11:41:38' success: true schema: $ref: '#/components/schemas/GetDebitMemoApplicationPartCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all application parts of a debit memo tags: - Debit Memos /v1/debit-memos/{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. operationId: GET_TaxationItemsOfDebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - 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). in: path name: dmitemid required: true schema: type: string - description: | The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: data: - balance: 10 creditAmount: 0 exemptAmount: 10 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402883836904567d01690530df760231 jurisdiction: Jurisdiction locationCode: '8' name: taxName_0 paymentAmount: 0 sourceTaxItemId: null taxAmount: 10 taxCode: taxCode taxCodeDescription: taxCodeDescription taxDate: '2016-10-10' taxRate: 0.1 taxRateDescription: taxRateDescription taxRateType: Percentage success: true schema: $ref: '#/components/schemas/GETTaxationItemsOfDebitMemoItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all taxation items of a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}: 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. Deletes a debit memo. Only debit memos with the Cancelled status can be deleted. You 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. The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items. operationId: DELETE_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a debit memo tags: - Debit Memos 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 debit memo. operationId: GET_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722ff25be58a1 accountNumber: AN_Test11679919358984 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: 0124a1a5d0f84d4288d875fc3b34b1e1 createdDate: '2023-03-27 17:46:01' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722ff2bff58b8 invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 0124a1a5d0f84d4288d875fc3b34b1e1 updatedDate: '2023-03-27 17:46:01' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo tags: - Debit Memos put: description: | **Notes:** - 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. - You 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. Updates 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. If the amount of a memo item is updated, the tax will be recalculated in the following conditions: - The memo is created from a product rate plan charge and you use Avalara to calculate the tax. - The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax. The [Edit credit and debit memos](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Adjust_invoice_amounts/Invoice_Settlement/Credit_memos_and_debit_memos/AC_Management_of_credit_and_debit_memos/Edit_credit_and_debit_memos#Edit_credit_memos_and_debit_memos_through_the_API) tutorial demonstrates how to use this operation to add and delete memo items. operationId: PUT_DebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTDebitMemoType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f82d133fe4 accountNumber: AN_Test11679918902100 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: Details about this Debit Memo createdById: 97e12d40f0ab4418a95a93118b272fb6 createdDate: '2023-03-27 17:38:24' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722f8335b3ffb invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: 97e12d40f0ab4418a95a93118b272fb6 updatedDate: '2023-03-27 17:38:27' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a debit memo tags: - Debit Memos /v1/debit-memos/{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. Cancels a debit memo. Only debit memos with the Draft status can be cancelled. You 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. operationId: PUT_CancelDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fd2e705066 accountNumber: AN_Test11679919230033 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: bc0211e8ca1440eb97a0aff808f87293 cancelledOn: '2023-03-27 17:43:59' comment: This is a comment createdById: bc0211e8ca1440eb97a0aff808f87293 createdDate: '2023-03-27 17:43:52' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722fd34c6507d invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722fd39fe5087 number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Canceled success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: bc0211e8ca1440eb97a0aff808f87293 updatedDate: '2023-03-27 17:43:59' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a debit memo tags: - Debit Memos /v1/debit-memos/{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. operationId: POST_DebitMemoCollect parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoCollectRequest' required: true responses: '200': content: application/json: examples: response: value: debitMemo: id: 8ad0912492f64b9001931936cac36351 number: DM00000001 appliedCreditMemos: [] appliedPayments: [] processedPayment: id: 8ad0869992f632860193249dfe1a0ead number: P-00001541 status: Processed amount: 10 paymentMethodId: 8ad09bce83f1da020183f97e24821c4b gatewayId: 8ad095dd813e750f0181461a8e350ce7 gatewayResponse: This transaction has been approved by the gateway. gatewayResponseCode: approve success: true schema: $ref: '#/components/schemas/DebitMemoCollectResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Collect a posted debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/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. Sends a posted debit memo to the specified email addresses manually. ### Notes - 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. - 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. - 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: * The `useEmailTemplateSetting` field is set to `false`. * The email addresses are not specified in the `emailAddresses` field. operationId: POST_EmailDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebitMemoEmailType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/files: 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. Uploads an externally generated PDF file for a debit memo that is in Draft or Posted status. To 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. This operation has the following restrictions: - Only the PDF file format is supported. - The maximum size of the PDF file to upload is 4 MB. - A maximum of 50 PDF files can be uploaded for one debit memo. operationId: POST_UploadFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | The PDF file to upload for the debit memo. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: fileId: 40289f466463d683016463ef8b7301a3 success: true schema: $ref: '#/components/schemas/POSTUploadFileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a debit memo tags: - Debit Memos x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@DebitMemoFile.pdf" "https://rest.zuora.com/v1/debit-memos/402890555a87d7f5015a8919e4fe002e/files" get: description: | Retrieves the information about all PDF files of a specified debit memo. Debit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field. **Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response. operationId: GET_DebitMemoFiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The unique ID or number of an debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: debitMemoFiles: - id: 8a90a24f8e128020018e12ebcd010470 pdfFileUrl: /v1/files/8a90a24f8e128020018e12ebccfa046f versionNumber: 1709714426109 - id: 8a90b5148c6d127b018c6d1e46160230 pdfFileUrl: /v1/files/8a90b5148c6d127b018c6d1e4610022f versionNumber: 1702637741618 success: true schema: $ref: '#/components/schemas/GETDebitMemoFilesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all files of a debit memo tags: - Debit Memos /v1/debit-memos/{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. Retrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. If 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`. Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100 - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate operationId: GET_DebitMemoItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `beAppliedAmount` field. in: query name: beAppliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `id` field. in: query name: id required: false schema: type: string - description: | This parameter filters the response based on the `serviceEndDate` field. in: query name: serviceEndDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `serviceStartDate` field. in: query name: serviceStartDate required: false schema: format: date type: string - description: | This parameter filters the response based on the `sku` field. in: query name: sku required: false schema: type: string - description: | This parameter filters the response based on the `skuName` field. in: query name: skuName required: false schema: type: string - description: | This parameter filters the response based on the `sourceItemId` field. in: query name: sourceItemId required: false schema: type: string - description: | This parameter filters the response based on the `subscriptionId` field. in: query name: subscriptionId required: false schema: type: string - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - 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. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by updated date. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - id - amount - beAppliedAmount - sku - skuName - serviceStartDate - serviceEndDate - sourceItemId - createdDate - createdById - updatedDate - updatedById - subscriptionId Examples: - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate - /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate in: query name: sort required: false schema: type: string responses: '200': content: application/json: examples: response: value: items: - amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: This is comment! createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:13:15' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a89251ede0046 processingType: Charge quantity: 1 serviceEndDate: '2017-11-30' serviceStartDate: '2017-11-01' sku: SKU-00000002 skuName: SKU-30 soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null taxMode: TaxExclusive taxationItems: data: - balance: 0.01 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a87d7f5015a89251ef10047 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 0.01 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-11-30' taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:13:15' success: true schema: $ref: '#/components/schemas/GETDebitMemoItemCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List debit memo items tags: - Debit Memos /v1/debit-memos/{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. operationId: GET_DebitMemoItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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). in: path name: dmitemid required: true schema: type: string - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 1 amountWithoutTax: 1 appliedToItemId: 402890555a7d4022015a2dadb3b700a6 balance: 1 beAppliedAmount: 0 comment: aa createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 17:01:00' excludeItemBillingFromRevenueAccounting: true financeInformation: deferredRevenueAccountingCode: Subscription Revenue deferredRevenueAccountingCodeType: SalesRevenue recognizedRevenueAccountingCode: Subscription Revenue recognizedRevenueAccountingCodeType: SalesRevenue id: 402890555a87d7f5015a8919e500002f processingType: Charge quantity: 1 serviceEndDate: '2017-03-26' serviceStartDate: '2017-02-27' sku: SKU-00000002 skuName: ZTax Component soldToContactId: 402881e522cf4f9b0122cf5d82860003 soldToContactSnapshotId: 402881e522cf4f9b0122cf5d82860004 sourceItemId: 402890555a7d4022015a7dadb3b700a6 sourceItemType: InvoiceDetail subscriptionId: null success: true taxMode: TaxExclusive taxationItems: data: - balance: 5 creditAmount: 0 exemptAmount: 0 financeInformation: salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a87d7f5015a8919e8450031 jurisdiction: USA locationCode: '' name: my tax paymentAmount: 0 sourceTaxItemId: 402890555a7d4022015a7dadb39b00a1 taxAmount: 5 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: desc3 taxRateType: FlatFee unitOfMeasure: Each unitPrice: 1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 17:01:00' schema: $ref: '#/components/schemas/GETDebitMemoItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a debit memo item tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/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. 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: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/POSTMemoPdfResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a debit memo PDF file tags: - Debit Memos /v1/debit-memos/{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. Posts 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). operationId: PUT_PostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722fa86dc4823 accountNumber: AN_Test11679919056161 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: e758a64e80f54439913241f9aa537127 createdDate: '2023-03-27 17:40:58' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722fa8d73483a invoiceGroupNumber: N-0001 latestPDFFileId: ac1ebc24569sd number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: e758a64e80f54439913241f9aa537127 postedOn: '2023-03-27 17:41:03' reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Posted success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: e758a64e80f54439913241f9aa537127 updatedDate: '2023-03-27 17:41:03' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a debit memo tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/taxation-items: 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. operationId: POST_DM_TaxationItems parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTTaxationItemListForDMType' required: true responses: '200': content: application/json: examples: response: value: taxationItems: - createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-18 11:32:56' exemptAmount: 0 id: 8ad0980c93300db701933d549f355262 memoItemId: 8ad093f793300daf01933d50a548781f invoiceItemId: null sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: STATE TAX taxAmount: 0.5 applicableTaxUnRounded: 0.5 country: null taxCode: ServiceTaxCode taxCodeDescription: null taxDate: '2024-11-18' taxRate: 0.05 taxMode: TaxExclusive taxRateDescription: null taxRateType: Percentage updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-18 11:32:56' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable accountsReceivableAccountingCode: Accounts Receivable accountsReceivableAccountingCodeType: AccountsReceivable success: true schema: $ref: '#/components/schemas/GETTaxationItemListType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create taxation items for a debit memo tags: - Debit Memos /v1/debit-memos/{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. Unposts 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. You 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). You can prevent an unpost operation by configuring the 'Do not allow unposting invoices and memos if their revenue is already recognized in a closed accounting period' accounting rule. The default value of this rule is set to 'disabled.' For more information, see [Configure Accounting Rules](https://knowledgecenter.zuora.com/Zuora_Payments/Zuora_Finance/D_Finance_Settings/D_Configure_Accounting_Rules#Do_not_allow_unposting_invoices_and_memos_if_their_revenue_is_already_recognized_in_a_closed_accounting_period). operationId: PUT_UnpostDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028ab1f87121698018722f3af193744 accountNumber: AN_Test11679918607694 amount: 100 autoPay: true balance: 100 beAppliedAmount: 0 billToContactId: null billToContactSnapshotId: null cancelledById: null cancelledOn: null comment: This is a comment createdById: c24f12918d5b45d0b7f9da297b8b7a9d createdDate: '2023-03-27 17:33:29' currency: USD debitMemoDate: '2023-03-27' dueDate: '2023-03-27' einvoiceErrorCode: null einvoiceErrorMessage: null einvoiceFileId: null einvoiceStatus: Processing id: 4028ab1f87121698018722f3b60c375b invoiceGroupNumber: N-0001 latestPDFFileId: 4028ab1f87121698018722f3bb0b376b number: DM00000001 organizationLabel: MS US paymentTerm: null postedById: null postedOn: null reasonCode: Correcting invoice error referredCreditMemoId: 1a2b3c4d5e6f referredInvoiceId: null sequenceSetId: null sourceType: Standalone status: Draft success: true targetDate: null taxAmount: 0 taxMessage: null taxStatus: Complete totalTaxExemptAmount: 0 transferredToAccounting: 'No' updatedById: c24f12918d5b45d0b7f9da297b8b7a9d updatedDate: '2023-03-27 17:33:42' schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unpost a debit memo tags: - Debit Memos /v1/debit-memos/invoice/{invoiceKey}: 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 an ad-hoc debit memo from an invoice. You 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. operationId: POST_DebitMemoFromInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8a90a19d9310bb3c0193197cb4700501 number: DM00000045 accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 debitMemoDate: '2024-11-11' currency: USD targetDate: null dueDate: '2024-12-11' postedOn: null postedById: null status: Draft amount: 10 taxAmount: 0 totalTaxExemptAmount: 0 balance: 10 beAppliedAmount: 0 autoPay: true comment: null referredInvoiceId: 8a90cc5c9301541f01930186636b1400 transferredToAccounting: false reasonCode: Correcting invoice error createdDate: '2024-11-11 12:30:23' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-11-11 12:30:23' updatedById: 2c92c8f95e2d6ebb015e325df48e02da cancelledOn: null cancelledById: null referredCreditMemoId: null latestPDFFileId: null taxStatus: null sourceType: Invoice taxMessage: null billToContactId: 8a90b4488e7d5c0f018e7db3896100b4 billToContactSnapshotId: null soldToContactId: null soldToContactSnapshotId: null paymentTerm: Net 30 eInvoiceStatus: null eInvoiceErrorCode: null eInvoiceErrorMessage: null eInvoiceFileId: null sequenceSetId: acd16fac492111e9a0d70cc47a32b062 invoiceGroupNumber: null success: true schema: $ref: '#/components/schemas/GETDebitMemoType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a debit memo from an invoice tags: - Debit Memos /v1/debit-memos/{debitMemoKey}/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. Writes off a debit memo. By writing off a debit memo, a credit memo is automatically created and applied to the debit memo. The generated credit memo items and credit memo taxation items are applied to the corresponding debit memo items and debit memo taxation items respectively. **Note**: * This API operation is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. * The total amount must be equal to the amount entered at the invoice item level. * If the non revenue impact value is set to Yes, then the non revenue write off accounting code must be specified. operationId: PUT_WriteOffDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoRequest' required: true responses: '200': content: application/json: examples: response: value: creditMemo: id: 402890555a40ca7f015a5b099b0e307a success: true schema: $ref: '#/components/schemas/PUTWriteOffDebitMemoResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Write off a debit memo tags: - Debit Memos /v1/einvoice/service-providers: get: description: | Lists information about e-invoicing service providers. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProviders parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: serviceProviders: - id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/ListEInvoicingServiceProvidersResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing service providers tags: - E-Invoicing post: description: | Creates an e-invoicing service provider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 apiKey: SampleApiKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/service-providers/{key}: delete: description: | Deletes an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing service provider tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to retrieve information about. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'false' companyIdentifier: CompanySample1 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing service provider tags: - E-Invoicing put: description: | Updates information about an e-invoicing service privider. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingServiceProvider parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoicing service provider that you want to update. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingServiceProviderRequest' required: true responses: '200': content: application/json: examples: response: value: id: 4028948972a2bf990172bc9b27724eef name: Sovos e-invoice service provider: Sovos serviceProviderNumber: EISP-00000001 test: 'true' companyIdentifier: CompanySample1 apiKey: SampleApiKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 schema: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing service provider tags: - E-Invoicing /v1/einvoice/business-regions: get: description: | Lists information about e-invoicing business regions. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: regions: - id: 8ad083528ee62fe1018eea6c5dd11e01 country: AU businessName: Avalara Inc. businessNumber: '74004085818' businessNumberSchemeId: '0151' tradeName: Test trade endpointId: '74004085818' endpointSchemeId: '0151' taxRegisterNumber: '1577240348' state: '' city: '' postalCode: '' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad093788ea359ca018ea75fb12a6348 businessRegionNumber: EIBR-00000010 digitalSignatureEnable: 'false' digitalSignatureBoxEnable: 'false' digitalSignatureBoxPosX: '0' digitalSignatureBoxPosY: '0' responseMapping: '{}' processType: PEPPOLNetwork invoiceEnabled: 'true' creditMemoEnabled: 'true' debitMemoEnabled: 'true' invoiceFilters: 'null' creditMemoFilters: 'null' debitMemoFilters: 'null' fileFormat: B2B: - XML B2C: - '' B2G: - XML - id: 8ad081dd8f7c5447018f7fdff3a75823 country: BR businessName: Seller business name businessNumber: '02593165000140' businessNumberSchemeId: '' tradeName: Seller trade name endpointId: Seller end point id 08992 endpointSchemeId: '099' taxRegisterNumber: TAX393982838 state: '' city: '' postalCode: '1' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad097b4905a5adf01907433df216e37 businessRegionNumber: EIBR-00000012 digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 responseMapping: {} processType: ClearanceWithCancellation invoiceEnabled: true creditMemoEnabled: false debitMemoEnabled: false invoiceFilters: null creditMemoFilters: null debitMemoFilters: null fileFormat: null success: true schema: $ref: '#/components/schemas/ListEInvoicingBusinessRegionsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoicing business regions tags: - E-Invoicing post: description: | Creates an e-invoicing business region. You must create business regions to store the business detail information as a seller. If you have multiple GSTINs for different states, you can create multiple business region objects for India. The business region objects can be looked up according to the country and state, and its related fields can be mapped accordingly within the e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: '' addressLine2: '' businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: '' country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: '' id: 4028b2aa8890c524018890c7e9ef3826 invoiceFilters: - objectType: Invoice condition: field: SoldToContact.Country operator: eq value: India phoneNumber: '' postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: '' taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoicing business region tags: - E-Invoicing /v1/einvoice/business-regions/{key}: delete: description: | Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to delete. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoicing business region tags: - E-Invoicing get: description: | Retrieves information about an e-invoicing business region. You can search for an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to retrieve information about. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: - id: 8ad083528ee62fe1018eea6c5dd11e01 country: AU businessName: Avalara Inc. businessNumber: '74004085818' businessNumberSchemeId: '0151' tradeName: Test trade endpointId: '74004085818' endpointSchemeId: '0151' taxRegisterNumber: '1577240348' state: '' city: '' postalCode: '' addressLine1: '' addressLine2: '' contactName: '' phoneNumber: '' email: '' serviceProviderId: 8ad093788ea359ca018ea75fb12a6348 businessRegionNumber: EIBR-00000010 digitalSignatureEnable: 'false' digitalSignatureBoxEnable: 'false' digitalSignatureBoxPosX: '0' digitalSignatureBoxPosY: '0' responseMapping: '{}' processType: PEPPOLNetwork invoiceEnabled: 'true' creditMemoEnabled: 'true' debitMemoEnabled: 'true' invoiceFilters: 'null' creditMemoFilters: 'null' debitMemoFilters: 'null' fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoicing business region tags: - E-Invoicing put: description: | Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_UpdateEInvoicingBusinessRegion parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unqiue ID or number of the e-invoicing business region that you want to update. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoicingBusinessRegionRequest' required: true responses: '200': content: application/json: examples: response: value: addressLine1: null addressLine2: null businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' businessRegionNumber: EIBR-00000002 city: Tokyo contactName: null country: JP digitalSignatureEnable: false digitalSignatureBoxEnable: false digitalSignatureBoxPosX: 0 digitalSignatureBoxPosY: 0 email: null endpointId: '8992' endpointSchemeId: '88' phoneNumber: null postalCode: '368779' responseMapping: {} serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: null taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML schema: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoicing business region tags: - E-Invoicing /v1/e-invoice/mandates: get: description: | Fetches mandates for downloading files based on the country code, category, and process type selection. This API operation returns the the list of file formats in which the document can be downloaded. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceMandates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | 2-digit country code. in: query name: countryCode schema: type: string example: AU - description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. in: query name: processType schema: type: string example: PEPPOLNetwork enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown - description: The service provider that is associated with the country and process type. in: query name: provider schema: type: string example: 8ad093788ea359ca018ea75fb12a6348 - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: data: - countryCode: AU fileFormats: - OASIS_UBL_XML - XML category: B2B processType: PEPPOLNetwork defaultFileFormats: 'null' - countryCode: AU fileFormats: - OASIS_UBL_XML - XML category: B2G processType: PEPPOLNetwork defaultFileFormats: 'null' success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: Mandate details are available only if Avalara is Integrated as service provider requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/EinvoiceFetchMandates' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List mandates for downloading files tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/mandate: get: description: | Fetches mandates for downloading e-invoice based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceMandateOnInvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the invoice. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: countryCode: AU fileFormats: - XML - OASIS_UBL_XM category: B2G defaultFileFormats: - XML processType: PEPPOLNetwork success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: E-Invoice for the document [] is not submitted to Avalara and hence this request cannot be accepted requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/EinvoiceInvoiceFetchMandate' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a file tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/mandate: get: description: | Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceCreditMemoMandate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the Credit Memo. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: countryCode: AU fileFormats: - XML - OASIS_UBL_XML category: B2G defaultFileFormats: - XML processType: PEPPOLNetwork success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: E-Invoice for the document [] is not submitted to Avalara and hence this request cannot be accepted requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/CreditMemosEinvoiceMandate' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a credit memo tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/mandate: get: description: | Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection. **Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled. operationId: getEinvoiceDebitMemoMandate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the Debit Memo. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: countryCode: AU fileFormats: - XML - OASIS_UBL_XML category: B2G defaultFileFormats: - XML processType: PEPPOLNetwork success: true Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: E-Invoice for the document [] is not submitted to Avalara and hence this request cannot be accepted requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/DebitMemosEinvoiceMandate' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a mandate for downloading a debit memo tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/download: get: description: | Downloads the e-invoice based on the selected file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. operationId: downloadEinvoiceOfSpecifiedFormat parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format. Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - description: | The unique number or ID of the e-invoice. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: {} Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File Format 'application/pdf' is not supported by Avalara for the document []. Supported values are [application/vnd.oasis.ubl+xml, application/xml] requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#2: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File download operation is supported only if the E-Invoice status is Success requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#3: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: Avalara Service is down at the moment. Please try again later requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/EinvoiceDownload' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a file in the specified file format tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/download/file: get: description: | Downloads the credit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. operationId: downloadCreditMemoEinvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format. Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - description: | The unique number or ID of Credit Memo. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: {} Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File Format 'application/pdf' is not supported by Avalara for the document []. Supported values are [application/vnd.oasis.ubl+xml, application/xml] requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#2: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File download operation is supported only if the E-Invoice status is Success requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#3: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: Avalara Service is down at the moment. Please try again later requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/CreditMemosEinvoiceDownload' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a credit memo in the specified file format tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/download/file: get: description: | Downloads the credit memo based on the specified file format. The system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. operationId: downloadDebitMemoEinvoice parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. When an invoice is processed through Sovos or PEPPOL, this parameter cannot be specified, and the document can only be downloaded in its default file format. Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` in: query name: fileFormat schema: type: string enum: - XML - PDF - ZIP - OASIS_Universal_Business_Language_XML - description: The unique number or ID of Debit Memo. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: Success: value: {} Validation Error#1: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File Format 'application/pdf' is not supported by Avalara for the document []. Supported values are [application/vnd.oasis.ubl+xml, application/xml] requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#2: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: File download operation is supported only if the E-Invoice status is Success requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c Validation Error#3: value: success: false processId: A214477BE49D98ED reasons: code: '50000020' message: Avalara Service is down at the moment. Please try again later requestId: 0e9c4ba6-a118-4f64-90df-23f7ce3d004c schema: $ref: '#/components/schemas/DebitMemosEinvoiceDownload' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Download a debit memo in the specified file format. tags: - E-Invoicing /v1/einvoice/templates: get: description: | Lists information about e-invoice file templates. You can query e-invoice file templates by conditions. For example, if your service provider is Sovos, you can use the following example URL to retrieve information about a list of e-invoice file templates for invoices in India: `/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos` **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. in: query name: country required: true schema: type: string - description: | The type of billing documents for which the e-invoice file template is intended. in: query name: documentType required: true schema: enum: - Invoice - CreditMemo - DebitMemo type: string - description: | The name of the e-invoicing service provider that assists in generating e-invoice files. in: query name: provider required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true templates: - country: SA documentType: Invoice id: 402833ec89d46b390189d51402d937b0 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000006 - country: SA documentType: CreditMemo id: 402833ec89d46b390189d514030537b2 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000008 - country: SA documentType: DebitMemo id: 402833ec89d46b390189d514032037b4 name: EInvoice Template Name provider: Sovos templateNumber: EITEMP-00000009 schema: $ref: '#/components/schemas/ListEInvoiceFileTemplatesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List e-invoice file templates tags: - E-Invoicing post: description: | Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. Zuora provides default e-invoice file templates, so you can just customize them as needed. For example, some country specific fields like HSN (Harmonized System of Nomenclature) might be stored on product rate plan charges. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: POST_CreateEInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an e-invoice file template tags: - E-Invoicing /v1/einvoice/templates/{key}: delete: description: | Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: DELETE_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the e-invoice file template that you want to delete. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an e-invoice file template tags: - E-Invoicing get: description: | Retrieves information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: GET_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to retrieve information about. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an e-invoice file template tags: - E-Invoicing put: description: | Updates information about an e-invoice file template. **Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. operationId: PUT_EInvoiceFileTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique number or ID of the e-invoice file template that you want to update. in: path name: key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEInvoiceFileTemplateRequest' required: true responses: '200': content: application/json: examples: response: value: content: base64 encoded content country: IN documentType: Invoice id: 4028818484f483d20184f5006b97003f name: Sovos e-invoice service provider: Sovos success: true templateNumber: EITEMP-00000003 schema: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an e-invoice file template tags: - E-Invoicing /v1/invoices/{invoiceKey}/e-invoice/sync-status: put: description: | Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the e-Invoice. **Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority`, and `RetrieveTimeout`. If the status is different, the request will be rejected. operationId: updateInvoiceInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: ' The e-Invoice ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of an e-Invoice.' in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: description: Unauthorized content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' examples: UnauthorizedExample: value: message: Authentication error PermissionErrorExample: value: code: 71012514 message: User does not have permission to delete custom objects. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of an invoice tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/sync-status: put: description: | Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the debit memo. **Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority` and `RetrieveTimeout`. If the status is different, the request will be rejected. operationId: updateDebitMemoInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: ' The debit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the debit memo.' in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: description: Unauthorized content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' examples: UnauthorizedExample: value: message: Authentication error PermissionErrorExample: value: code: 71012514 message: User does not have permission to delete custom objects. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of a debit memo tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/sync-status: put: description: | Initiates a background polling process to retrieve the latest notification response from the configured e-Invoicing provider and update the e-Invoice status of the credit memo. **Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority`, and `RetrieveTimeout`. If the status is different, the request will be rejected. operationId: updateCreditMemoInvokeSyncStatus parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: ' The credit memo ID or number. The system checks the latest notification response from the configured e-Invoicing provider and updates the e-Invoice status of the credit memo.' in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: description: Unauthorized content: application/json: schema: oneOf: - $ref: '#/components/schemas/ProxyUnauthorizedResponse' - $ref: '#/components/schemas/CommonResponse' examples: UnauthorizedExample: value: message: Authentication error PermissionErrorExample: value: code: 71012514 message: User does not have permission to delete custom objects. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number WWW-Authenticate: description: 'The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` ' schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Sync the e-Invoice status of a credit memo tags: - E-Invoicing /v1/invoices/{invoiceKey}/einvoice/generate: put: description: | Generates an e-invoice file for an invoice. If the invoice status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to **Processing**. **Note**: E-invoicing with Sovos is generally available. E-invoicing with Avalara and E-invoicing with PEPPOL are in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing them as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. The **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. operationId: PUT_GenerationEInvoiceGenerationForInvoices parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001. in: path name: invoiceKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for an invoice tags: - E-Invoicing /v1/credit-memos/{creditMemoKey}/e-invoice/generate: put: description: | Generates an e-invoice file for a credit memo. If the Credit Memo status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to **Processing**. **Note**: E-invoicing with Sovos is generally available. E-invoicing with Avalara and E-invoicing with PEPPOL are in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing them as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. The **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. operationId: PUT_GenerateEInvoiceFileForCreditMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001. in: path name: creditMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a credit memo tags: - E-Invoicing /v1/debit-memos/{debitMemoKey}/e-invoice/generate: put: description: | Generates an e-invoice file for a debit memo. If the Credit Memo status is **Failed** during e-invoice generation, you can use **Regenerate E-Invoice**. Once you fix the errors and trigger the regeneration, the system will resubmit the document to the e-invoicing service provider, and its status will update to **Processing**. **Note**: E-invoicing with Sovos is generally available. E-invoicing with Avalara and E-invoicing with PEPPOL are in the **Early Availability** phase. We are actively soliciting feedback from a small set of early adopters before releasing them as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. The **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. operationId: PUT_GenerateEInvoiceFileForDebitMemo parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001. in: path name: debitMemoKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate an e-invoice file for a debit memo tags: - E-Invoicing /v1/invoice-schedules: post: description: | Creates an invoice schedule. ### Limitations This API operation has the following limitations: * You can create at most 50 invoice schedule items in one request. * You can associate at most 10 orders with an invoice schedule in one request. * You can associate at most 300 subscriptions with an invoice schedule in one request, including those contained in orders and separate subscriptions. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_CreateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 50000 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}: delete: description: | Deletes an invoice schedule in Pending status. The status of the invoice schedule to be deleted must be `Pending`. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: DELETE_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an invoice schedule tags: - Invoice Schedules get: description: | Retrieves detailed information about an invoice schedule. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: GET_InvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: actualAmount: 20200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an invoice schedule tags: - Invoice Schedules put: description: | Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects: - Update notes and pending invoice schedule items - Update orders associated with invoice schedules - Remove or add invoice schedule items For more samples, see Edit invoice schedules ### Restrictions and limitations When updating invoice schedules through the REST API, keep the following restrictions and limitations in mind: - You can only update invoice schedule items in `Pending` status. - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules. - For the invoice schedule items that you want to update, you must include the new values for these items in the request. - For the invoice schedule items that you want to keep unchanged, you must include all the existing information about these items in the request. Otherwise, the existing invoice schedule items that you do not include in the request are deleted. - For the orders that you want to keep unchanged for an invoice schedule, you must include all the existing order numbers associated with the invoice schedule in the request. Otherwise, the existing orders that you do not include in the request are removed. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_UpdateInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTUpdateInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: actualAmount: 70200 additionalSubscriptionsToBill: - S-00000001 - S-00000002 billedAmount: 0 currency: USD id: e2441b3e24eb42859194be7da2403b38 invoiceSeparately: false nextRunDate: '2022-02-24' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 54000 amount: 54000 id: 8a8881aa82118bec018211daf9f01680 percentage: null runDate: '2022-02-24' status: Pending targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 10000 amount: 10000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Pending success: true totalAmount: 70200 unbilledAmount: 70200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/execute: post: description: | Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. When you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID. - If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed. - If you do not specify the ID of any invoice schedule item in the request, the subscription end date is used as the target date to determine the next pending schedule item to be executed. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by this "Execute an invoice schedule" API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API For more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules). **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: POST_ExecuteInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTExecuteInvoiceScheduleRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ExecuteInvoiceScheduleBillRunResponse' autoEmail: examples: response: value: false autoPost: examples: response: value: false autoRenewal: examples: response: value: false billRunFilters: examples: response: value: - accountId: 8ad09c4b82b5c6330182c5ccab3570e6 filterType: InvoiceSchedule billRunNumber: examples: response: value: BR-00001017 createdById: examples: response: value: 2c92c0f84298ac5901429dea196212be createdDate: examples: response: value: '2022-08-22 06:47:18' id: examples: response: value: 8ad0823f82b5b2520182c5cec5fe40fb invoiceDate: examples: response: value: '2022-02-24' noEmailForZeroAmountInvoice: examples: response: value: false status: examples: response: value: Pending success: examples: response: value: true targetDate: examples: response: value: '2022-02-24' updatedById: examples: response: value: 2c92c0f84298ac5901429dea196212be updatedDate: examples: response: value: '2022-08-22 06:47:18' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Execute an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/pause: put: description: | Pauses an invoice schedule immediately. A paused invoice schedule and charges inside cannot be automatically executed by Zuora Scheduler or by the Execute an invoice schedule API operation. In this case, you can do one of the following: - Use the Generate billing documents by account ID API operation - Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_PauseInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: Paused success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Pause an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/resume: put: description: | Resumes an invoice schedule in Paused status immediately. After an invoice schedule is resumed, it can continue to be automatically executed by Zuora Scheduler or by the [Execute an invoice schedule](https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/) API operation. **Note**: This operation is available only if you have the Billing Schedule feature enabled. operationId: PUT_ResumeInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: actualAmount: 20200 billedAmount: 50000 currency: USD id: e2441b3e24eb42859194be7da2403b38 nextRunDate: '2022-10-17' notes: 2022 Billing Schedule number: IS-00000004 orders: - O-00000007 - O-00000008 scheduleItems: - actualAmount: 0 amount: 50000 id: 8a8881aa82118bec018211daf9f01680 invoiceId: 8a8881aa82118bec018211dafc1e1695 percentage: null runDate: '2022-02-24' status: Processed targetDateForAdditionalSubscriptions: '2022-02-24' - actualAmount: 14000 amount: 14000 id: 8a8881aa82118bec018211daf9f11681 percentage: null runDate: '2022-10-17' status: Pending targetDateForAdditionalSubscriptions: '2022-10-17' - actualAmount: 6200 amount: 6200 id: 8a8881aa82118bec018211daf9f11682 percentage: null runDate: '2022-11-14' status: Pending targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 status: PartiallyProcessed success: true totalAmount: 70200 unbilledAmount: 20200 schema: $ref: '#/components/schemas/InvoiceScheduleResponses' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resume an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/detach: put: description: | Detaches charges from an invoice schedule. The invoice schedules you want to detach charges from must be in Fully Processed or Partially Processed status. Invoice schedules do not bill detached charges. operationId: detachChargesFromInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to detach charges from. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/DetachInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Detach charges from an invoice schedule tags: - Invoice Schedules /v1/invoice-schedules/{scheduleKey}/attach: put: description: | Attaches charges to an invoice schedule. The invoice schedules you want to attach charges to must be in Fully Processed or Partially Processed status. You can attach charges only if they were previously detached from the same invoice schedule. Invoice schedules will automatically bill re-attached charges in the upcoming planned invoice schedule items. operationId: attachChargesToInvoiceSchedule parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of the invoice schedule to attach charges to. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001. in: path name: scheduleKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/AttachInvoiceScheduleRequest' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Attach charges to an invoice schedule tags: - Invoice Schedules /v1/object/taxation-item: post: description: Creates a Taxation Item object. operationId: Object_POSTTaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_REQUEST_rejectUnknownFields' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ProxyCreateTaxationItem' required: true responses: '200': content: application/json: examples: response: value: Id: 2c93808457d787030157e0306f413a96 Success: true schema: $ref: '#/components/schemas/ProxyCreateOrModifyResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: examples: response: value: Errors: - Code: INVALID_VALUE Message: The account number 123xProxy is invalid. Success: false schema: $ref: '#/components/schemas/ProxyBadRequestResponse' description: '' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '401': content: application/json: examples: response: value: message: Authentication error schema: $ref: '#/components/schemas/ProxyUnauthorizedResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number WWW-Authenticate: description: | The value of this header is: ``` Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API ``` schema: enum: - Basic realm=Zuora API, ZSession realm=Zuora API, Bearer realm=Zuora API type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: 'CRUD: Create a taxation item' tags: - Taxation Items /v1/taxation-items/{id}: delete: description: | Deletes a specific taxation item by ID. operationId: DELETE_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a taxation item tags: - Taxation Items get: description: | Retrieves the information about a specific taxation item by ID. operationId: GET_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-02-27 11:52:03' exemptAmount: 0 financeInformation: onAccountAccountingCode: Check onAccountAccountingCodeType: Cash salesTaxPayableAccountingCode: Check salesTaxPayableAccountingCodeType: Cash id: 402890555a7d4022015a7db254e200c8 jurisdiction: null locationCode: null memoItemId: 402890555a7d4022015a7db254d800c7 name: my tax sourceTaxItemId: 402890555a7d4022015a7db254e200c1 success: true taxAmount: 1 taxCode: ZtaxCode taxCodeDescription: '' taxDate: '2017-02-27' taxRate: 5 taxRateDescription: null taxRateType: FlatFee updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-02-27 11:52:03' schema: $ref: '#/components/schemas/GETTaxationItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: | Retrieve a taxation item tags: - Taxation Items put: description: | Updates a specific taxation item by ID. operationId: PUT_TaxationItem parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a taxation item. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTTaxationItemType' required: true responses: '200': content: application/json: examples: response: value: createdById: 8ad084a67f9c7138017fab8a8b511b5a createdDate: '2024-11-04 10:53:16' exemptAmount: 0 id: 8ad09d9392e0a4430192f51746d121f6 memoItemId: null invoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161 sourceTaxItemId: null jurisdiction: CALIFORNIA locationCode: null name: CA TAX taxAmount: 3 applicableTaxUnRounded: 3 country: null taxCode: null taxCodeDescription: null taxDate: '2024-11-04' taxRate: 3 taxMode: TaxExclusive taxRateDescription: Details of the tax rate taxRateType: FlatFee updatedById: 8ad084a67f9c7138017fab8a8b511b5a updatedDate: '2024-11-04 10:57:51' financeInformation: onAccountAccountingCode: null onAccountAccountingCodeType: null salesTaxPayableAccountingCode: Sales Tax Payable salesTaxPayableAccountingCodeType: SalesTaxPayable success: true schema: $ref: '#/components/schemas/GETTaxationItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a taxation item tags: - Taxation Items /v1/sequence-sets: get: description: | Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can use query parameters to restrict the data returned in the response. **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. operationId: GET_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - description: | The name or number of a specific sequence set. in: query name: name required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: sequenceSets: - creditMemo: prefix: CM startNumber: 11 debitMemo: prefix: DM startNumber: 12 id: 2c98906c69be199c0169be74ed210afd invoice: prefix: INV startNumber: 10 name: DEFAULT payment: prefix: P- startNumber: 13 refund: prefix: R- startNumber: 14 - creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 id: 2c98906c69be199c0169be74ed211afd invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 - creditMemo: prefix: ITACM startNumber: 11 debitMemo: prefix: ITADM startNumber: 12 id: 2c98906c69be199c0169be74ed212afd invoice: prefix: ITAINV startNumber: 10 name: ITA payment: prefix: ITAP- startNumber: 13 refund: prefix: ITAR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List sequence sets tags: - Sequence Sets post: description: | Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. You can create a maximum of 100 sequence sets in one single request. A sequence set comprises a set of custom prefixes and starting numbers that are used for billing documents to generate, and payments and refunds to create. See [Prefix and Numbering Configuration for Billing Documents](https://knowledgecenter.zuora.com/CB_Billing/Billing_Settings/Prefix_and_Numbering_Configuration_for_Billing_Documents) for more information about limitations. **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. operationId: POST_SequenceSets parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTSequenceSetsRequest' required: true responses: '200': content: application/json: examples: response: value: sequenceSets: - id: 402892c74c9193cd014c96bbe7c101f9 name: FR creditMemo: prefix: FCM startNumber: 10 debitMemo: prefix: FDM startNumber: 10 invoice: prefix: FINV startNumber: 10 payment: prefix: FP- startNumber: 10 refund: prefix: FR- startNumber: 10 success: true schema: $ref: '#/components/schemas/POSTSequenceSetsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create sequence sets tags: - Sequence Sets /v1/sequence-sets/{id}: delete: description: | Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **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. operationId: DELETE_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to delete. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a sequence set tags: - Sequence Sets get: description: | Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos **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. operationId: GET_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to retrieve information about. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: creditMemo: prefix: FCM startNumber: 11 debitMemo: prefix: FDM startNumber: 12 invoice: prefix: FINV startNumber: 10 name: FR payment: prefix: FP- startNumber: 13 refund: prefix: FR- startNumber: 14 success: true schema: $ref: '#/components/schemas/GETSequenceSetResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a sequence set tags: - Sequence Sets put: description: | Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos. **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. operationId: PUT_SequenceSet parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID or number of the sequence set to update. in: path name: id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTSequenceSetRequest' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/PUTSequenceSetResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a sequence set tags: - Sequence Sets /v1/operations/billing-preview: post: description: | Generates a preview of future invoice items for one customer account. Use the BillingPreview call to calculate how much a single customer will be invoiced from the most recent invoice to a specific end of term date in the future. Additionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption. The BillingPreview call only calculates taxes for charges in the subscription if you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item uses the [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode); otherwise, this call does not calculate taxes. If you have the Invoice Settlement feature enabled, you can also generate a preview of future credit memo items for one customer account. 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. operationId: POST_BillingPreview parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewParam' required: true responses: '200': content: application/json: examples: response: value: accountId: 8ad09bce83f1da020183f97e245c1c47 invoiceItems: - id: d573746814a14da0a0a0abda2a41d65a subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-08-01' serviceEndDate: '2024-08-31' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 - id: c86c42ee4f5b42bd86351f4a99bf230e subscriptionName: A-S00000346 subscriptionId: 8ad08ad58e35d490018e36a0f1ca2a9c subscriptionNumber: A-S00000346 serviceStartDate: '2024-09-01' serviceEndDate: '2024-09-30' chargeAmount: 10 chargeDescription: '' chargeName: Monthly Fee chargeNumber: C-00000950 chargeId: 8ad08ad58e35d490018e36a0f2252aa5 productName: Music service quantity: 1 taxAmount: 0 unitOfMeasure: '' chargeDate: '2024-07-09 17:06:58' chargeType: Recurring processingType: Charge appliedToItemId: null numberOfDeliveries: 0 success: true schema: $ref: '#/components/schemas/BillingPreviewResult' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Generate a billing preview tags: - Operations /v1/operations/invoice-collect: post: description: | Generates and posts invoices and credit memos and collects payments for posted invoices. Credit memos are only available if you have the Invoice Settlement feature enabled and negative charges exist. Credit memos will not be applied to invoices. If draft invoices and credit memos exist when you run this operation, this operation will post the invoices and credit memos. Note that draft credit memos created from an invoice or a product rate plan charge will not be posted. You can use this operation to generate invoices and collect payments on the posted invoices, or else simply collect payment on a specified existing invoice. The customer's default payment method is used, and the full amount due is collected. The operation depends on the parameters you specify. - To generate one or more new invoices for that customer and collect payment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty. - To collect payment on an existing invoice, specify the invoice ID. The operation is atomic; if any part is unsuccessful, the entire operation is rolled back. When an error occurs, gateway reason codes and error messages are returned the error response of this operation. The following items are some gateway response code examples. - Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number` - Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card` - CyberSource2: `202 Expired card`; `231 Invalid account number` For more reason code information, see the corresponding payment gateway documentation. ### Notes Timeouts may occur when using this method on an account that has an extremely high number of subscriptions. operationId: POST_TransactionInvoicePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTInvoiceCollectType' required: true responses: '200': content: application/json: examples: response: value: amountCollected: 801.73 creditMemos: - id: 402890555a7e9791015a879f064a0054 totalAmount: 801.73 memoNumber: CM00000012 invoices: - invoiceAmount: 801.73 invoiceId: 4028925a4cb74ec9014cb7540988002e invoiceNumber: INV00000091 paymentId: 402892053e100406013e1024ab7c00e3 success: true schema: $ref: '#/components/schemas/POSTInvoiceCollectResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Invoice and collect tags: - Operations /v1/operations/jobs/{jobId}: get: description: | Retrieves information about a specific operation job. Currently, you can only use this API operation to retrieve the status information about invoice deletion and reversal operation jobs. operationId: GET_OperationJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab. in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: id: 4028818484a949680184a95174cb0019 objectId: 4028818484a949680184a9510c960009 objectType: Invoice operationType: Delete status: Completed success: true schema: $ref: '#/components/schemas/GetOperationJobResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an operation job tags: - Operations /v1/operations/bulk-pdf: post: description: | The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs. operationId: Create_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobRequestType' required: true responses: '200': content: application/json: example: jobId: 402880de8ce7edc3018ce7f18404312a jobName: BulkPDFGenerationJobV1 status: Completed stepStatus: PostProcessing fileUrls: skippedDocuments: - docType: Invoice objectIds: - 8a90a04d8e323748018e327b4a0825a0 - docType: CreditMemo objectIds: - 402880de8ce7edc3018ce7f18404315a createdBy: 2c92c8fb7a2d26b6017a2eaa64c72dea createdOn: '2024-04-19 05:19:32' success: true schema: $ref: '#/components/schemas/POSTBulkPdfGenerationJobResponseType' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '400': content: application/json: example: processId: processId reasons: - code: '51580020' message: All Document IDs provided in this request were either invalid or the billing document is not available. success: false requestId: d4b8c683-04ff-407d-964a-a63ae7917483 schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Export bulk PDF files tags: - Operations x-accepts: application/json x-codegen-request-body-name: Request x-content-type: application/json /v1/operations/bulk-pdf/{jobId}: get: description: Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link. operationId: Get_BulkPDFToZIPGeneration parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - description: The ID of the job for which information needs to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab in: path name: jobId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: example: jobId: 2c92c8955bd63cc1015bd7c151af02ab jobName: BulkPDFGenerationJobV1 status: Completed stepStatus: PostProcessing fileUrls: - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 createdOn: '2024-01-08 12:52:05' createdBy: caf630704a6f4100818601625ecffe0b success: true schema: $ref: '#/components/schemas/GETBulkpdfGenerationJobResponseType' description: OK headers: Content-Encoding: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Content_Encoding' RateLimit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Limit' RateLimit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Remaining' RateLimit-Reset: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_RateLimit_Reset' Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve information of a bulk PDF file generation job tags: - Operations x-accepts: application/json /v1/bill-runs: post: description: | Creates an ad-hoc bill run or a scheduled bill run. Support the following: - Create ad-hoc or scheduled bill runs by batch - Create ad-hoc or scheduled bill runs by account - Create a bill run by subscription - Create ad-hoc or scheduled bill runs by custom filter combining the Account, Subscription, and Rate Plan objects. To use this operation, you must have the Create Bill Runs billing permission. **Notes** When using this operation to create bill runs, keep the following notes in mind: - When creating bill runs by batch, you must specify the `batches` field and do not specify `billRunFilters` field. When creating bill runs by account, subscription, or custom filter, you must specify the `billRunFilters` field and do not specify the `batches` field. - When creating bill runs by account, only one single account is allowed. All subscription under the account are picked up. - When creating a bill run by subscription, 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. operationId: POST_CreateBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateBillRunRequestType' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a bill run tags: - Bill Run /v1/bill-runs/{billRunId}: delete: description: | Deletes a bill run. You can only delete bill runs in `Canceled` or `Error` status. operationId: DELETE_DeleteBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a bill run tags: - Bill Run get: description: | Retrieves the information about a specific bill run. operationId: GET_BillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/cancel: put: 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. operationId: PUT_CancelBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: example: cancelOnce: true properties: cancelOnce: default: true description: | Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run. type: boolean type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CancelBillRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a bill run tags: - Bill Run /v1/bill-runs/{billRunId}/post: put: 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`. operationId: PUT_PostBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a bill run. in: path name: billRunId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: example: invoiceDate: '2022-01-01' properties: invoiceDate: description: | The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period. format: date type: string required: - invoiceDate type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetBillRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Post a bill run tags: - Bill Run /v1/bill-runs/{billRunKey}/emails: post: description: | Manually emails all the billing documents that are generated from a specified bill run to your customers. Bill 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. Using 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. ### Notes - Even though no field is required in the Request body, you still need to specify `{}` in the request. Otherwise, an error will be returned. - You can only email posted billing documents. - You must activate the following notifications before emailing invoices and credit memos: - **Manual Email For Invoice | Manual Email For Invoice** - **Email Credit Memo | Manually email Credit Memo** - 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. - 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: - Invoices: **Invoice Posted Default Email Template** - Credit memos: **Manual Email for Credit Memo Default Template** See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information. operationId: POST_EmailBillingDocumentsfromBillRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001. in: path name: billRunKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTEmailBillingDocfromBillRunType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Email billing documents generated from a bill run tags: - Bill Run /v1/billing-preview-runs: post: 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. operationId: POST_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostBillingPreviewRunParam' required: true responses: '200': content: application/json: examples: response: value: billingPreviewRunId: 402890b757d1ec1b0157d5aa3d6802aa success: true schema: properties: billingPreviewRunId: description: | Id of the billing preview run. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a billing preview run tags: - Billing Preview Run /v1/billing-preview-runs/{billingPreviewRunId}: get: 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. A 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. operationId: GET_BillingPreviewRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' - description: | Id of the billing preview run. in: path name: billingPreviewRunId required: true schema: type: string responses: '200': content: application/json: examples: response: value: assumeRenewal: Autorenew batches: '' chargeTypeToExclude: OneTime createdById: 4028906d58240f960158241132be0003 createdDate: '2016-11-04 16:18:56' endDate: '2016-11-04 16:19:00' errorMessage: null includingDraftItems: false includingEvergreenSubscription: true resultFileUrl: https://rest.zuora.com/v1/files/4028906d582d21a101582e6b663c0a65 runNumber: BPR-00000010 startDate: '2016-11-04 16:19:00' status: Completed succeededAccounts: 7 success: true targetDate: '2016-12-01' totalAccounts: 7 updatedById: 4028906d58240f960158241132be0003 updatedDate: '2016-11-04 16:19:00' schema: $ref: '#/components/schemas/GetBillingPreviewRunResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a billing preview run tags: - Billing Preview Run /v1/payment-methods: post: description: | You can use this operation to create either a payment method associated with a specific customer account, or an orphan payment method that is not associated with any customer account. To view the applicable fields for each payment method type, select the payment method type from the `type` list. The following types of the payment methods are supported: * `CreditCard` - Credit card payment method. * `CreditCardReferenceTransaction` - Credit Card Reference Transaction. See [Supported payment methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods) for payment gateways that support this type of payment method. * `ACH` - ACH payment method. * `SEPA` - Single Euro Payments Area. * `Betalingsservice` - Direct Debit DK. * `Autogiro` - Direct Debit SE. * `Bacs` - Direct Debit UK. * `Becs` - Direct Entry AU. * `Becsnz` - Direct Debit NZ. * `PAD` - Pre-Authorized Debit. * `PayPalCP` - PayPal Commerce Platform payment method. Use this type if you are using a [PayPal Commerce Platform Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway) instance. * `PayPalEC` - PayPal Express Checkout payment method. Use this type if you are using a [PayPal Payflow Pro Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Payflow_Pro%2C_Website_Payments_Payflow_Edition%2C_Website_Pro_Payment_Gateway) instance. * `PayPalNativeEC` - PayPal Native Express Checkout payment method. Use this type if you are using a [PayPal Express Checkout Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway) instance. * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if you are using a [PayPal Adaptive Payment Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway) instance. * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay) for details. * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay) for details. * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway integration. See [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase) for details. * `AmazonPay` - Amazon Pay integration. The fields marked as `required` must be specified when creating non-tokenized payment methods. For more information about the required fields for the tokenization of payment methods, see Create tokenized payment methods with existing tokens or account information. operationId: POST_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92a09650a7a80a0150ab50a5b746bd success: true schema: $ref: '#/components/schemas/POSTPaymentMethodResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment method tags: - Payment Methods /v1/payment-methods/decryption: post: description: | The decryption API endpoint can conditionally perform 4 tasks in one atomic call: * Decrypt Apple Pay Payment token * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information * Create a stored credential profile within the Apple Pay payment method * Process Payment on a specified Invoice (optional) operationId: POST_PaymentMethodsDecryption parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPaymentMethodDecryption' required: true responses: '200': content: application/json: examples: response: value: paymentMethodId: 2c92c8f83dcbd8b1013dcce1d6a600ce success: true schema: $ref: '#/components/schemas/POSTPaymentMethodResponseDecryption' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an Apple Pay payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}: delete: description: | Deletes a credit card payment method. If the specified payment method is the account's default payment method, the request will fail. In that case, you must first designate a different payment method for that customer to be the default. operationId: DELETE_PaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is needed.) in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a payment method tags: - Payment Methods get: description: | Use this operation to get the detailed information of an electronic payment method. To retrieve information of both electronic and non-electronic payment methods, use the [Object Query](https://developer.zuora.com/v1-api-reference/api/operation/queryPaymentMethodByKey/) operation. **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. operationId: GET_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique ID of the payment method to update. in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: AA_PICKLIST__c: null accountHolderInfo: accountHolderName: John Smith addressLine1: ABC addressLine2: EFT city: Example City country: United States email: example@google.com phone: '86123456789' state: Example State zipCode: '844000' accountKey: 4028839f7ca29000017ca29c1ce8003f bankIdentificationNumber: '411111' cardBinInfo: brand: Visa cardClass: Credit productType: Consumer_Card issuer: JPMORGAN CHASE BANK N.A. issuingCountryCode: US cardNumber: '************1111' createdBy: 402881e522cf4f9b0122cf5d82860002 createdDate: '2021-11-15 18:59:08' creditCardType: Visa deviceSessionId: null existingMandate: null expirationMonth: 11 expirationYear: 2027 id: 4028839f7d26a155017d26af16ef0001 identityNumber: '97370192024' ipAddress: null isDefault: true lastFailedSaleTransactionDate: null lastTransaction: Approved lastTransactionDateTime: '2021-11-15 18:59:08' lastTransactionStatus: Approved mandateInfo: mitConsentAgreementRef: null mitConsentAgreementSrc: null mitProfileAction: null mitProfileAgreedOn: null mitProfileType: null mitTransactionId: null maxConsecutivePaymentFailures: null numConsecutiveFailures: 0 paymentRetryWindow: null status: Active success: true totalNumberOfErrorPayments: 0 totalNumberOfProcessedPayments: 0 type: CreditCard updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2021-11-15 18:59:08' useDefaultRetryRule: true schema: $ref: '#/components/schemas/GETPaymentMethodResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment method tags: - Payment Methods put: description: | This operation allows you to update an existing payment method. The following fields in the request body can be updated for any payment method types: - `maxConsecutivePaymentFailures` - `paymentRetryWindow` - `useDefaultRetryRule` The following fields in the request body can be updated for any payment method types except for Credit Card Reference Transaction payment methods: - `authGateway` - `accountHolderInfo` - `gatewayOptions` - `ipAddress` - Custom fields The following fields in the request body can be updated only for Credit Card payment methods: - `expirationMonth` - `expirationYear` - `securityCode` The following field in the request body can be updated for Credit Card, Credit Card Reference Transaction, ACH, and Bank Transfer payment methods: - `mandateInfo` operationId: PUT_PaymentMethod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Unique ID of the payment method to update. in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPaymentMethodRequest' required: true responses: '200': content: application/json: examples: response: value: id: 2c92c0f86c99b4eb016cae1ee301728f success: true schema: $ref: '#/components/schemas/PUTPaymentMethodResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/verify: put: description: | Sends an authorization request to the corresponding payment gateway to verify the payment method, even though no changes are made for the payment method. Supported payment methods are Credit Cards and Paypal. Zuora now supports performing a standalone zero dollar verification or one dollar authorization for credit cards. It also supports a billing agreement status check on PayPal payment methods. If a payment method is created by Hosted Payment Pages and is not assigned to any billing account, the payment method cannot be verified through this operation. operationId: PUT_VerifyPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The ID of the payment method to be verified. in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodType' required: true responses: '200': content: application/json: examples: response: value: paymentMethodId: 402890765d9ce329015da18034ee0057 success: true schema: $ref: '#/components/schemas/PUTVerifyPaymentMethodResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Verify a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/scrub: put: description: | This operation enables you to replace all sensitive data in a payment method, related payment method snapshot table, and four related log tables with dummy values that will be stored in Zuora databases. This operation will scrub the sensitive data and soft-delete the specified payment method at the same time. If you want to delete or anonymize personal data in Zuora, you must scrub the payment method before anonymizing the associated account and contact. See [Delete or anonymize personal data](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Responding_to_individual_requests_for_access%2C_correction%2C_and_deletion_of_data_under_applicable_privacy_laws#Edit_and_correct_personal_data) for more information. **Note:** In order to use this operation, you must ensure that the **Scrub Sensitive Data of Specific Payment Method payments** permission is enabled in your user role. Contact your tenant administrator if you want to enable this permission. See [Scrub Payment Methods](https://knowledgecenter.zuora.com/CB_Billing/L_Payment_Methods/Scrub_Payment_Methods) for more information. operationId: PUT_ScrubPaymentMethods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the payment method where you want to scrub the sensitive data. in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Scrub a payment method tags: - Payment Methods /v1/payment-methods/{payment-method-id}/balance: get: summary: Retrieve the balance of a bank account tags: - Payment Methods description: | Zuora supports Plaid's Auth and Balance products for ACH transactions. Auth authenticates account details before sending requests to the gateway, while Balance checks the real-time account balance before transactions. Use this API operation to implement the integration with Plaid Balance manually. Before you use this API operation, ensure that the support for Plaid Auth and Balance is enabled. For more information, see Enable the support for Plaid account validation solution. operationId: getBankAccountBalance parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The unique ID of the payment method, such as `40289f3291d2587b0191d280fa20012g`. in: path name: payment-method-id required: true schema: type: string format: uuid - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true currency: USD availableBalance: 100 currentBalance: 110.55 schema: $ref: '#/components/schemas/GetBankAccountBalanceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: Only ACH payment method is supported to check balance. requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /v1/payment-methods/{payment-method-id}/profiles: get: description: | Retrieves the stored credential profiles within a payment method. operationId: GET_StoredCredentialProfiles parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Specifies whether to retrieve all the stored credential profiles within the payment method. By default, Zuora returns only the stored credential profiles with `Agreed` or `Active` status. If you set this parameter to `true`, Zuora returns all the stored credential profiles. in: query name: includeAll schema: default: false type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: profiles: - activatedOn: '2019-03-06 07:45:55' agreedOn: '2019-03-06 07:45:55' brand: Visa cancelledOn: '2019-03-13 07:52:16' consentAgreementRef: ACCT1338AgreementV1.pdf consentAgreementSrc: External expiredOn: null number: 1 paymentMethodId: 402881836953a3c7016953aec290000d status: Cancelled type: Recurring - activatedOn: '2019-03-13 07:55:08' agreedOn: '2019-03-13 07:55:08' brand: Visa cancelledOn: null consentAgreementRef: ACCT1338AgreementV2.pdf consentAgreementSrc: External expiredOn: null number: 2 paymentMethodId: 402881836953a3c7016953aec290000d status: Active type: Recurring success: true schema: $ref: '#/components/schemas/GetStoredCredentialProfilesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List stored credential profiles of a payment method tags: - Payment Methods post: description: | Creates a stored credential profile within a payment method. The stored credential profile represents a consent agreement that you have established with a customer. When you use the payment method in a transaction, Zuora may include information from the stored credential profile to inform the payment processor that the transaction is related to your pre-existing consent agreement with the customer. operationId: POST_CreateStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStoredCredentialProfileRequest' required: true responses: '200': content: application/json: examples: response: value: number: 3 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a stored credential profile tags: - Payment Methods /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel: post: description: | Cancels a stored credential profile within a payment method. Cancelling the stored credential profile indicates that the stored credentials are no longer valid, per a customer request. You cannot reactivate the stored credential profile after you have cancelled it. operationId: POST_CancelStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Number that identifies a stored credential profile within the payment method. in: path name: profile-number required: true schema: type: integer - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: number: 1 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel" /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire: post: description: | Expires a stored credential profile within a payment method. Expiring the stored credential profile indicates that the stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. You cannot reactivate the stored credential profile after you have expired it. operationId: POST_ExpireStoredCredentialProfile parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | ID of a payment method. in: path name: payment-method-id required: true schema: type: string - description: | Number that identifies a stored credential profile within the payment method. in: path name: profile-number required: true schema: type: integer - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: number: 2 paymentMethodId: 402881836953a3c7016953aec290000d success: true schema: $ref: '#/components/schemas/ModifiedStoredCredentialProfileResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Expire a stored credential profile tags: - Payment Methods x-code-samples: - label: Curl lang: curl source: | curl -X POST -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" "https://rest.zuora.com/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire" /payment-methods/apple-pay/domains: get: description: | Use this operation to retrieve details of your domains that are already registered with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK. You can use `domainName` as the query parameter to restrict domains returned in the response. Specify a domain name and the registered domains containing the specified domain name will be returned. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: GET_ListApplePayDomains parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Specifies a domain name such as `zuora.com` and the registered domains containing the specified domain name will be returned. For example, `test1.zuora.com` and `test2.zuora.com` are two registered domains, but `zuora.com` is not registered. If you specify `zuora.com` in this query field, the data of `test1.zuora.com` and `test2.zuora.com` will be returned. in: query name: domainName schema: type: string responses: '200': content: application/json: examples: response: value: domains: - createdBy: 402881e522cf4f9b0122cf5d82860002 createdOn: '2023-07-05 00:44:51' domainName: testapplepay.zuora.com domainVerified: true id: 402881a38924ff1001892502da090021 updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2023-07-05 00:44:51' - createdBy: 402881e522cf4f9b0122cf5d82860002 createdOn: '2023-07-04 01:02:12' domainName: test1.zuora.com domainVerified: false id: 402881a3891fe7b401891fec61d40036 updatedBy: 402881e522cf4f9b0122cf5d82860002 updatedOn: '2023-07-04 01:02:12' success: true schema: $ref: '#/components/schemas/GETListApplePayDomainsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List registered Apple Pay domains tags: - Payment Methods post: description: | Before adding Apple Pay to your checkout flow by integrating with the JavaScript SDK provided by Zuora, your domains that will show the Apple Pay button must be registered with Apple. Use this operation to register a domain. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: POST_RegisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainRequest' required: true responses: '200': content: application/json: examples: response: value: domainName: testapplepay.zuora.com domainVerified: true id: 402881a38924ff1001892502da090021 success: true schema: $ref: '#/components/schemas/POSTRegisterApplePayDomainResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Register an Apple Pay domain tags: - Payment Methods /payment-methods/apple-pay/domains/{id}: delete: description: | Use this operation to unregister a domain with Apple for Apple Pay button integration implemented through Zuora's JavaScript SDK. For more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach. operationId: DELETE_UnregisterApplePayDomain parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the domain, such as `402881a38924ff1001892502da090021`. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/DELETEUnresigerApplePayDomainResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unregister an Apple Pay domain tags: - Payment Methods /web-payments/sessions: post: description: | Use this operation to create a payment session on your server side. The response contains a token for the payment session data. In addition to the required `accountId` and `currency` fields, you can specify the following fields to define the payment flow mode as one of the following: - Create and save a payment method: - `processPayment`: `false` - `storePaymentMethod`: `true` - `amount` - Process a one-time payment without saving the payment method: - `processPayment`: `true` - `storePaymentMethod`: `false` - `amount` or `invoices` + `amount` - Process the first payment and save the payment method for subsequent recurring payments: - `processPayment`: `true` - `storePaymentMethod`: `true` - `amount` or `invoices` + `amount` For more information, see the following articles: - Payment Form Implementation Guide - Set up a payment method through JavaScript SDK integration - Set up Alipay payment methods with Zuora JavaScript SDK operationId: POST_CreatePaymentSession parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreatePaymentSessionRequest' required: true responses: '200': content: application/json: examples: response: value: token: LTljuuLaDQnHxeVpWaX6zq2xY2FJ6sSE schema: $ref: '#/components/schemas/POSTCreatePaymentSessionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment session tags: - Payment Methods /v1/payments: 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 all payments from all your customer accounts. ### Filtering You can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body. The `unappliedAmount` or any other query parameter does not support the less than(<) and the greater than(>) operators. If 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`. Examples: - /v1/payments?status=Processed - /v1/payments?currency=USD&status=Processed - /v1/payments?status=Processed&type=External&sort=+number operationId: GET_RetrieveAllPayments parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | This parameter filters the response based on the `accountId` field. in: query name: accountId required: false schema: type: string - description: | This parameter filters the response based on the `amount` field. in: query name: amount required: false schema: format: double type: number - description: | This parameter filters the response based on the `appliedAmount` field. in: query name: appliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `createdById` field. in: query name: createdById required: false schema: type: string - description: | This parameter filters the response based on the `createdDate` field. in: query name: createdDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `creditBalanceAmount` field. in: query name: creditBalanceAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `currency` field. in: query name: currency required: false schema: type: string - description: | This parameter filters the response based on the `effectiveDate` field. in: query name: effectiveDate required: false schema: format: date-time type: string - description: | This parameter filters the response based on the `number` field. in: query name: number required: false schema: type: string - description: | This parameter filters the response based on the `refundAmount` field. in: query name: refundAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `status` field. in: query name: status required: false schema: enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string - description: | This parameter filters the response based on the `type` field. in: query name: type required: false schema: enum: - External - Electronic type: string - description: | This parameter filters the response based on the `unappliedAmount` field. in: query name: unappliedAmount required: false schema: format: double type: number - description: | This parameter filters the response based on the `updatedById` field. in: query name: updatedById required: false schema: type: string - description: | This parameter filters the response based on the `updatedDate` field. in: query name: updatedDate required: false schema: format: date-time type: string - 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. A sortable field uses the following form: *operator* *field_name* You 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* *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. - The `-` operator indicates an ascending order. - The `+` operator indicates a descending order. By default, the response data is displayed in descending order by payment number. *field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below: - number - accountId - amount - appliedAmount - unappliedAmount - refundAmount - creditBalanceAmount - effectiveDate - createdDate - createdById - updatedDate - updatedById Examples: - /v1/payments?sort=+number - /v1/payments?status=Processed&sort=-number,+amount in: query name: sort required: false schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: payments: - accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 amount: 44.1 appliedAmount: 44.1 authTransactionId: null bankIdentificationNumber: null cancelledOn: null comment: normal payment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' creditBalanceAmount: 0 currency: USD effectiveDate: '2017-03-01' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null transferredToAccounting: 'No' unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null gatewayId: null gatewayOrderId: null gatewayReconciliationReason: null gatewayReconciliationStatus: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted id: 4028905f5a87c0ff015a87eb6b75007f markedForSubmissionOn: null number: P-00000001 paymentGatewayNumber: PG-00000001 paymentMethodId: 402881e522cf4f9b0122cf5dc4020045 paymentMethodSnapshotId: null payoutId: null referenceId: null refundAmount: 0 secondPaymentReferenceId: null settledOn: null softDescriptor: null softDescriptorPhone: null status: Processed submittedOn: null type: External unappliedAmount: 0 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' success: true schema: $ref: '#/components/schemas/PaymentCollectionResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List payments tags: - Payments post: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Creates a payment in the following scenarios: - A full or partial payment on an invoice or a debit memo - A full or partial payment on several invoices and debit memos - An unapplied payment in the following situations: - You do not know which customer account the payment belongs to. - You know which customer account the payment belongs to, but you do not know which invoice the payment is applied to. - You receive a payment from your customer that exceeds the balance on the invoice. - You receive a payment from your customer before the invoice has been created. - You intend to create a payment without any invoices or debit memos. - A standalone payment. If you only need to create and process an electronic payment in Zuora through a Zuora gateway integration but settle the payment outside of Zuora, you can create a standalone payment. For a standalone payment, you can specify a currency different from the payment currency in the customer account settings. When Standalone Payment is not enabled, the currency of the standalone payment can be different from the payment currency defined in the customer account settings if you have the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature enabled. If you do not know to which customer account the payment belongs, you can create a payment without specifying a customer account. When you create a payment, the total number of invoice items and debit memo items that the payment will apply to should be less than or equal to 15,000. For more information, see [Create Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments) and [Create Payments Without Specifying Customer Accounts](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/AA_Create_Payments_Without_Specifying_Customer_Accounts). operationId: POST_CreatePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePaymentType' required: true responses: '200': content: application/json: examples: response: value: id: 8a90a04d914ac24801914b29e47f0777 number: P-00000389 status: Processed type: External accountId: 8a90b4488e7d5c0f018e7db3892400b2 accountNumber: A00000370 amount: 14.99 appliedAmount: 14.99 unappliedAmount: 0 refundAmount: 0 creditBalanceAmount: 0 currency: USD effectiveDate: '2024-08-13' comment: null paymentMethodId: 2c92c8f95e2d6ebb015e325df7a70356 paymentMethodSnapshotId: null authTransactionId: null bankIdentificationNumber: null gatewayId: null paymentGatewayNumber: null gatewayOrderId: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted markedForSubmissionOn: null referenceId: null secondPaymentReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: null settledOn: null cancelledOn: null createdDate: '2024-08-13 17:55:22' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-08-13 17:55:22' updatedById: 2c92c8f95e2d6ebb015e325df48e02da financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null prepayment: false success: true schema: $ref: '#/components/schemas/GETARPaymentTypeWithPaymentOption' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a payment tags: - Payments /v1/payments/{paymentId}: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Updates a payment. operationId: PUT_UpdatePayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`. in: path name: paymentId required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePaymentType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028905f5a87c0ff015a88889fe500a8 accountNumber: A00000001 amount: 44.1 appliedAmount: 0 authTransactionId: null bankIdentificationNumber: null cancelledOn: null comment: Details about this payment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' creditBalanceAmount: 0 currency: USD effectiveDate: '2017-03-01' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null transferredToAccounting: 'No' unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null gatewayId: null gatewayOrderId: null gatewayReconciliationReason: null gatewayReconciliationStatus: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted id: 4028905f5a87c0ff015a87eb6b75007f markedForSubmissionOn: null number: P-00000001 paymentGatewayNumber: PG-00000001 paymentMethodId: 402881e522cf4f9b0122cf5dc4020045 paymentMethodSnapshotId: null payoutId: null referenceId: null refundAmount: 0 secondPaymentReferenceId: null settledOn: null softDescriptor: null softDescriptorPhone: null status: Processed submittedOn: null success: true type: External unappliedAmount: 44.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:25:34' schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a payment tags: - Payments /v1/payments/{paymentKey}: 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. Deletes a payment. Only payments with the Cancelled status can be deleted. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be deleted. operationId: DELETE_Payment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a payment tags: - Payments 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 one specific payment. operationId: GET_Payment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028905f5a87c0ff015a87d25ae90025 accountNumber: A00000001 amount: 44.1 appliedAmount: 44.1 authTransactionId: null bankIdentificationNumber: null cancelledOn: null comment: normal payment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' creditBalanceAmount: 0 currency: USD effectiveDate: '2017-03-01' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null transferredToAccounting: 'No' unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null gatewayId: null gatewayOrderId: null gatewayReconciliationReason: null gatewayReconciliationStatus: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted id: 4028905f5a87c0ff015a87eb6b75007f markedForSubmissionOn: null number: P-00000001 paymentGatewayNumber: PG-00000001 paymentMethodId: 402881e522cf4f9b0122cf5dc4020045 paymentMethodSnapshotId: null payoutId: null referenceId: null refundAmount: 0 secondPaymentReferenceId: null settledOn: null softDescriptor: null softDescriptorPhone: null status: Processed submittedOn: null success: true type: External unappliedAmount: 0 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment tags: - Payments /v1/payments/{paymentKey}/apply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Applies an unapplied payment to invoices and debit memos. When you apply a payment, the total number of invoice items and debit memo items that the payment will apply to must be less than or equal to 15,000. If the limit is hit, you can follow the instructions: - If you want to apply one payment to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to apply one payment to a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000. For more information, see [Apply Unapplied Payments to Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Apply_Unapplied_Payments_to_Invoices_and_Debit_Memos). operationId: PUT_ApplyPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/ApplyPaymentType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad0835290c4bb2f0190c9b5407c52a3 number: P-00000018 status: Processed type: External accountId: 8ad097b490c4e5aa0190c9612d9c7034 accountNumber: A00000122 amount: 14.99 appliedAmount: 12 unappliedAmount: 2.99 refundAmount: 0 creditBalanceAmount: 0 currency: USD effectiveDate: '2024-07-18' comment: null paymentMethodId: 2c92c0f86cccaa59016cd5e0c41c0e89 paymentMethodSnapshotId: null authTransactionId: null bankIdentificationNumber: null gatewayId: null paymentGatewayNumber: null gatewayOrderId: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted markedForSubmissionOn: null referenceId: null secondPaymentReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: null settledOn: null cancelledOn: null createdDate: '2024-07-18 23:36:57' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-18 23:41:55' updatedById: b243314d594646d3b2651aeedd4be47e financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: Accounts Receivable unappliedPaymentAccountingCodeType: AccountsReceivable transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Apply a payment tags: - Payments /v1/payments/{paymentKey}/cancel: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Cancels a payment. If you have the Invoice Settlement feature enabled, overpayments applied to credit balance cannot be cancelled. operationId: PUT_CancelPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountId: 4028905f5a87c0ff015a88889fe500a8 accountNumber: A00000001 amount: 44.1 appliedAmount: 0 authTransactionId: null bankIdentificationNumber: null cancelledOn: null comment: new comment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' creditBalanceAmount: 0 currency: USD effectiveDate: '2017-03-01' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null transferredToAccounting: 'No' unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null gatewayId: null gatewayOrderId: null gatewayReconciliationReason: null gatewayReconciliationStatus: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted id: 4028905f5a87c0ff015a87eb6b75007f markedForSubmissionOn: null number: P-00000001 paymentGatewayNumber: PG-00000001 paymentMethodId: 402881e522cf4f9b0122cf5dc4020045 paymentMethodSnapshotId: null payoutId: null referenceId: null refundAmount: 0 secondPaymentReferenceId: null settledOn: null softDescriptor: null softDescriptorPhone: null status: Canceled submittedOn: null success: true type: External unappliedAmount: 44.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:26:57' schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a payment tags: - Payments /v1/payments/{paymentKey}/parts: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all parts of a payment. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a payment. Note that a fully refunded payment does not contain any payment part. operationId: GET_PaymentParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: parts: - amount: 4.1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoId: 4028905f5a87c0ff015a87e49e6b0062 id: 4028905f5a87c0ff015a87eb6beb008d invoiceId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' - amount: 40 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoId: null id: 4028905f5a87c0ff015a87eb6beb008c invoiceId: 4028905f5a87c0ff015a87d3f8f10043 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' success: true schema: $ref: '#/components/schemas/GETPaymentPartsCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all parts of a payment tags: - Payments /v1/payments/{paymentKey}/parts/{partid}: get: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific payment part. A payment can consist of an unapplied part, and several parts applied to invoices and debit memos. A fully refunded payment does not contain any payment part. operationId: GET_PaymentPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts). in: path name: partid required: true schema: type: string - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 4.1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoId: 4028905f5a87c0ff015a87e49e6b0062 id: 4028905f5a87c0ff015a87eb6beb008d invoiceId: null success: true updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' schema: $ref: '#/components/schemas/GETPaymentPartType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment part tags: - Payments /v1/payments/{paymentKey}/parts/{partid}/item-parts: get: description: | **Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about all items of a payment part. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items. operationId: GET_PaymentItemParts parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts). in: path name: partid required: true schema: type: string - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: itemParts: - amount: 4 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063 id: 4028905f5a87c0ff015a87eb6bd8008a invoiceItemId: null taxItemId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' - amount: 0.1 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoItemId: null id: 4028905f5a87c0ff015a87eb6bd8008b invoiceItemId: null taxItemId: 4028905f5a87c0ff015a87e49f5e0065 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' success: true schema: $ref: '#/components/schemas/GETPaymentItemPartCollectionType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all payment part items tags: - Payments /v1/payments/{paymentKey}/parts/{partid}/item-parts/{itempartid}: get: description: | **Note:** This operation is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Retrieves the information about a specific payment part item. A payment part item is a single line item in a payment part. A payment part can consist of several different types of items. operationId: GET_PaymentItemPart parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a payment](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentParts). in: path name: partid required: true schema: type: string - description: | The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part items](https://www.zuora.com/developer/api-references/api/operation/GET_PaymentItemParts). in: path name: itempartid required: true schema: type: string - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: amount: 4 createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' debitMemoItemId: 4028905f5a87c0ff015a87e49e7a0063 id: 4028905f5a87c0ff015a87eb6bd8008a invoiceItemId: null success: true taxItemId: null updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 11:30:37' schema: $ref: '#/components/schemas/GETPaymentItemPartType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a payment part item tags: - Payments /v1/payments/{paymentKey}/refunds: post: description: | **Note:** This operation is only available if you have 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 for more information. Refunds a full or partial unapplied payment to your customers. To refund applied payments, you must unapply the applied payments from the invoices or debit memos, and then refund the unapplied payments to customers. For more information on the payment refund use case, see Payment schedules use cases in the Knowledge Center. For more information, see Refund Payments. operationId: POST_RefundPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostRefundType' required: true responses: '200': content: application/json: examples: response: value: id: 8a90a04d90de54810190debe8e3b5a2c number: R-00000287 status: Processed type: Electronic methodType: CreditCard accountId: 8a90b4488e7d5c0f018e7db3892400b2 amount: 10 refundDate: '2024-07-23' comment: null paymentMethodId: 8a90e5e490c9ceb80190d8e9df930bf0 paymentMethodSnapshotId: 8a90a04d90de54810190debe8e0c5a29 paymentId: 8a90e5e490c9ceb80190d91837840c1d paymentNumber: P-00000387 creditMemoId: null reasonCode: null gatewayId: 8a90d6128ddbaf39018de2d9fe0d2660 paymentGatewayNumber: PG-00000001 gatewayResponse: Approved gatewayResponseCode: OK gatewayState: Submitted markedForSubmissionOn: null referenceId: null secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: '2024-07-23 16:39:09' settledOn: null cancelledOn: null createdDate: '2024-07-23 16:39:08' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-07-23 16:39:12' updatedById: 2c92c8f95e2d6ebb015e325df48e02da refundTransactionTime: '2024-07-23 16:39:09' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETRefundPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a payment tags: - Payments /v1/payments/{paymentKey}/refunds/unapply: post: description: |- **Note:** This operation is only available if you have 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 for more information. Refunds a full or partial unapplied payment to your customers, without the need to unapply the payment first, followed by processing the refund. To refund applied payments, you can now leverage this API to unapply and refund the payment simultaneously. For more information on the payment refund use case, see Payment schedules use cases in the Knowledge Center. For more information, see Refund a payment with auto-unapplying. **Note**: This API operation is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. operationId: POST_RefundPaymentwithAutoUnapply parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostRefundwithAutoUnapplyType' required: true responses: '200': content: application/json: examples: response: value: id: 8a90e4a79310d4b00193196d987670fe number: R-00000289 status: Processed type: Electronic methodType: CreditCard accountId: 8a90b4488e7d5c0f018e7db3892400b2 amount: 10 refundDate: '2024-11-11' comment: null paymentMethodId: 8a90b44890c9bb0d0190d960b9191eea paymentMethodSnapshotId: 8a90e4a79310d4b00193196d981370fb paymentId: 8a90f26f92f732c70192fb5323d227ad paymentNumber: P-00000394 creditMemoId: null reasonCode: null gatewayId: 8a90d6128ddbaf39018de2d9fe0d2660 paymentGatewayNumber: PG-00000001 gatewayResponse: Approved gatewayResponseCode: OK gatewayState: Submitted markedForSubmissionOn: null referenceId: '' secondRefundReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: '2024-11-11 12:13:53' settledOn: null cancelledOn: null createdDate: '2024-11-11 12:13:52' createdById: 2c92c8f95e2d6ebb015e325df48e02da updatedDate: '2024-11-11 12:14:03' updatedById: 2c92c8f95e2d6ebb015e325df48e02da refundTransactionTime: '2024-11-11 12:13:53' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null writeOff: false writeOffResults: null success: true schema: $ref: '#/components/schemas/GETRefundPaymentTypeAutoUnapply' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Refund a payment with auto-unapplying tags: - Payments /v1/payments/{paymentKey}/transfer: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Transfers an unapplied payment. For more information, see [Transfer Unapplied Payments](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Transfer_Unapplied_Payments). operationId: PUT_TransferPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/TransferPaymentType' required: true responses: '200': content: application/json: examples: response: value: accountId: 4028905f5a87c0ff015a88889fe500a8 accountNumber: A00000001 amount: 44.1 appliedAmount: 0 authTransactionId: null bankIdentificationNumber: null cancelledOn: null comment: normal payment createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2017-03-01 11:30:37' creditBalanceAmount: 0 currency: USD effectiveDate: '2017-03-01' financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null transferredToAccounting: 'No' unappliedPaymentAccountingCode: null unappliedPaymentAccountingCodeType: null gatewayId: null gatewayOrderId: null gatewayReconciliationReason: null gatewayReconciliationStatus: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted id: 4028905f5a87c0ff015a87eb6b75007f markedForSubmissionOn: null number: P-00000001 paymentGatewayNumber: PG-00000001 paymentMethodId: 402881e522cf4f9b0122cf5dc4020045 paymentMethodSnapshotId: null payoutId: null referenceId: null refundAmount: 0 secondPaymentReferenceId: null settledOn: null softDescriptor: null softDescriptorPhone: null status: Processed submittedOn: null success: true type: External unappliedAmount: 44.1 updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2017-03-01 14:22:58' schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Transfer a payment tags: - Payments /v1/payments/{paymentKey}/unapply: put: description: | **Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Unapplies an applied payment from invoices and debit memos. When you unapply a payment, the total number of invoice items and debit memo items that the payment will unapply from must be less than or equal to 15,000. If the limit is hit, you can follow the instructions: - If you want to unapply one payment without specifying invoices or debit memos, you have to specify the invoices or debit memos in the request. - If you want to unapply one payment from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request. - If you want to unapply one payment from a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000. For more information, see [Unapply Payments from Invoices and Debit Memos](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/A_Unapplied_Payments/Management_of_Unapplied_Payments/Unapply_Payments_from_Invoices_and_Debit_Memos). operationId: PUT_UnapplyPayment parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`. in: path name: paymentKey required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/UnapplyPaymentType' required: true responses: '200': content: application/json: examples: response: value: id: 8ad0835290c4bb2f0190c9b5407c52a3 number: P-00000018 status: Processed type: External accountId: 8ad097b490c4e5aa0190c9612d9c7034 accountNumber: A00000122 amount: 14.99 appliedAmount: 0 unappliedAmount: 14.99 refundAmount: 0 creditBalanceAmount: 0 currency: USD effectiveDate: '2024-07-18' comment: null paymentMethodId: 2c92c0f86cccaa59016cd5e0c41c0e89 paymentMethodSnapshotId: null authTransactionId: null bankIdentificationNumber: null gatewayId: null paymentGatewayNumber: null gatewayOrderId: null gatewayResponse: null gatewayResponseCode: null gatewayState: NotSubmitted markedForSubmissionOn: null referenceId: null secondPaymentReferenceId: null softDescriptor: null softDescriptorPhone: null submittedOn: null settledOn: null cancelledOn: null createdDate: '2024-07-18 23:36:57' createdById: b243314d594646d3b2651aeedd4be47e updatedDate: '2024-07-19 00:03:20' updatedById: b243314d594646d3b2651aeedd4be47e financeInformation: bankAccountAccountingCode: null bankAccountAccountingCodeType: null unappliedPaymentAccountingCode: Accounts Receivable unappliedPaymentAccountingCodeType: AccountsReceivable transferredToAccounting: false gatewayReconciliationStatus: null gatewayReconciliationReason: null payoutId: null success: true schema: $ref: '#/components/schemas/GETARPaymentType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Unapply a payment tags: - Payments /v1/summary-statement-runs: post: description: | Allows you to initiate the generation of a summary statement run. You can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts). operationId: createSummaryStatementRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SummaryStatementRunRequestType' examples: Example1: value: description: This is a sample response for accounts from a batch with a billCycleDay of 01. runType: AdHoc targetAccountCategory: AllAccounts batchName: Batch1 billCycleDay: '01' dateRangeType: PreviousOneCalendarMonth autoEmailEnabled: false Example2: value: description: This is a sample response for accounts from a batch with open invoices. runType: AdHoc targetAccountCategory: AccountsWithOpenInvoices batchName: Batch1 dateRangeType: PreviousOneCalendarMonth autoEmailEnabled: false Example3: value: description: This is a sample response for accounts from a batch with a billCycleDay of 01 that has open invoices. runType: AdHoc targetAccountCategory: AccountsWithOpenInvoices batchName: Batch1 dateRangeType: PreviousOneCalendarMonth autoEmailEnabled: false responses: '200': content: application/json: examples: response: value: id: 402881869169397401916d8ff8d218c5 statementRunNumber: SSR-00000004 targetAccountCategory: AllAccounts accountKey: null runType: AdHoc batchName: Batch51 billCycleDay: null dateRangeType: PreviousThreeCalendarMonth startDate: '2024-05-01 19:13:57' endDate: '2024-07-31 19:13:57' autoEmailEnabled: false description: HelloWorld status: Pending createdById: 402881e522cf4f9b0122cf5d82860002 createdDate: '2024-08-19 19:13:57' updatedById: 402881e522cf4f9b0122cf5d82860002 updatedDate: '2024-08-20 10:13:57.586' success: true schema: $ref: '#/components/schemas/SummaryStatementRunResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: description: This header is returned if you specify the `Accept-Encoding:\ \ gzip` request header and the response contains over 1000 bytes of data.\n\ \nNote that only the following MIME types support gzipped responses:\n\ \ - `application/json`\n - `application/xml`\n - `text/html`\n - `text/csv`\n\ \ - `text/plain`\n" schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API 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: maxLength: 64 type: string 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: description: 'The Zuora internal identifier of the API call. You cannot control the value of this header. ' schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: 'A custom identifier for tracing the API 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: maxLength: 64 type: string summary: Create a summary statement run tags: - Summary Statements /v1/accounting-codes: get: description: This reference describes how to query all accounting codes in your chart of accounts through the REST API. operationId: GET_AllAccountingCodes parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountingCodes: - category: Assets createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2014-07-29 02:20:20' glAccountName: null glAccountNumber: null id: e20b0747478025a10147816ba1c20097 name: Accounts Receivable notes: null status: Active type: AccountsReceivable updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2014-07-29 02:20:20' - category: Revenue createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2014-07-29 02:20:20' glAccountName: null glAccountNumber: null id: e20b0747478025a10147816ba21900a0 name: Discounts notes: null status: Inactive type: SalesDiscounts updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2014-09-27 22:11:07' success: true schema: $ref: '#/components/schemas/GETAccountingCodesType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all accounting codes tags: - Accounting Codes post: description: | This reference describes how to create a new accounting code through the REST API. The accounting code will be active as soon as it has been created. ### Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Configure Accounting Codes permission. operationId: POST_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountingCodeType' required: true responses: '200': content: application/json: examples: response: value: id: 8a8081ae547aac1e01547efb61f20140 success: true schema: $ref: '#/components/schemas/POSTAccountingCodeResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}: delete: 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. operationId: DELETE_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting code you want to delete. in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an accounting code tags: - Accounting Codes get: description: This reference describes how to query an accounting code through the REST API. operationId: GET_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting code you want to query. in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: category: Assets createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2016-05-04 01:23:07' glAccountName: null glAccountNumber: null id: 8a8081ae547aac1e01547efb61f20140 name: CASH notes: null status: Active success: true type: Cash updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-05-05 20:07:38' schema: $ref: '#/components/schemas/GETAccountingCodeItemType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an accounting code tags: - Accounting Codes put: description: | This reference describes how to update an existing accounting code through the REST API. ### Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. ### Limitations You can only update accounting codes that are not already associated with any transactions. operationId: PUT_AccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting code you want to update. in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountingCodeType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}/activate: put: description: | This reference describes how to activate an accounting code through the REST API. Prerequisites ------------- If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. operationId: PUT_ActivateAccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting code you want to activate. in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Activate an accounting code tags: - Accounting Codes /v1/accounting-codes/{ac-id}/deactivate: put: description: | This reference describes how to deactivate an accounting code through the REST API. ### Prerequisites If you have Zuora Finance enabled on your tenant, you must have the Manage Accounting Code permission. ### Limitations You can only deactivate accounting codes that are not associated with any transactions. You cannot disable accounting codes of type AccountsReceivable. operationId: PUT_DeactivateAccountingCode parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting code you want to deactivate. in: path name: ac-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': description: OK content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Deactivate an accounting code tags: - Accounting Codes /v1/accounting-periods: get: description: Retrieves all accounting periods on your tenant. operationId: GET_AllAccountingPeriods parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_accounting' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountingPeriods: - createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2016-03-16 23:17:25' endDate: '2016-03-31' fileIds: accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f01538340274a13f4 accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f01538340273013f3 arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null revenueDetailCsvFileId: 8a8081ae5374904f0153834033221418 revenueDetailExcelFileId: 8a8081ae5374904f0153834032e41417 unprocessedChargesFileId: null fiscalYear: 2016 id: 8a8081ae5374904f01538338b66e1005 name: Mar 2016 notes: '' 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.' runTrialBalanceStart: '2016-03-16 23:25:22' runTrialBalanceStatus: Error startDate: '2016-03-01' status: Open updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-03-16 23:25:22' - createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2016-03-16 23:17:50' endDate: '2016-04-30' fileIds: accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5374904f0153833e9a7a1364 accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5374904f0153833e9a651363 arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null revenueDetailCsvFileId: 8a8081ae5374904f0153833ea2d613af revenueDetailExcelFileId: 8a8081ae5374904f0153833ea2c813ae unprocessedChargesFileId: null fiscalYear: 2016 id: 8a8081ae5374904f0153833918af1007 name: Apr 2016 notes: '' runTrialBalanceEnd: null runTrialBalanceErrorMessage: null runTrialBalanceStart: '2016-03-16 23:23:40' runTrialBalanceStatus: Error startDate: '2016-04-01' status: Open updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-03-16 23:23:40' - createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2016-03-16 23:23:29' endDate: '2016-05-31' fileIds: accountsReceivableAccountAgingDetailExportFileId: null accountsReceivableInvoiceAgingDetailExportFileId: null arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null revenueDetailCsvFileId: 8a8081ae54c2eabb0154c307e2920034 revenueDetailExcelFileId: 8a8081ae54c2eabb0154c307e27e0033 unprocessedChargesFileId: null fiscalYear: 2016 id: 8a8081ae5374904f0153833e4590132d name: May 2016 notes: '' runTrialBalanceEnd: null runTrialBalanceErrorMessage: null runTrialBalanceStart: '2016-05-18 01:42:30' runTrialBalanceStatus: Error startDate: '2016-05-01' status: Open updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-05-18 01:42:30' - createdBy: 402881e522cf4f9b0122cf5d82860002 createdOn: '2014-07-28 23:52:46' endDate: null fileIds: accountsReceivableAccountAgingDetailExportFileId: null accountsReceivableInvoiceAgingDetailExportFileId: null arRollForwardDetailExportFileId: null fxRealizedGainAndLossDetailExportFileId: null fxUnrealizedGainAndLossDetailExportFileId: null revenueDetailCsvFileId: null revenueDetailExcelFileId: null unprocessedChargesFileId: null fiscalYear: 0 id: e20b0747478025a1014780e489a60002 name: Open-Ended notes: null runTrialBalanceEnd: null runTrialBalanceErrorMessage: null runTrialBalanceStart: null runTrialBalanceStatus: Pending startDate: '2016-06-01' status: Open updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2016-03-16 23:23:29' success: true schema: $ref: '#/components/schemas/GETAccountingPeriodsType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all accounting periods tags: - Accounting Periods post: 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. operationId: POST_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTAccountingPeriodType' required: true responses: '200': content: application/json: examples: response: value: id: 7b7181ae547aac1e01547efb61f20162 success: true schema: $ref: '#/components/schemas/POSTAccountingPeriodResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}: delete: 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. operationId: DELETE_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period you want to delete. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an accounting period tags: - Accounting Periods get: description: | Retrieves an accounting period. **Prerequisites**: You must have Zuora Finance enabled on your tenant. operationId: GET_AccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period you want to get. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: createdBy: e20b074746ec48f40147140f51e30a1a createdOn: '2014-11-25 22:21:22' endDate: '2014-10-31' fileIds: accountsReceivableAccountAgingDetailExportFileId: 8a8081ae5002967c015012f1230e0914 accountsReceivableInvoiceAgingDetailExportFileId: 8a8081ae5002967c015012f122f10913 accountsReceivableDebitMemoAgingDetailExportFileId: 8a8081ae5002967c015012f122f40913 arRollForwardDetailExportFileId: 8a8081ae5002967c015012f15d7b09e2 fxRealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f151a609ba fxUnrealizedGainAndLossDetailExportFileId: 8a8081ae5002967c015012f150b509b8 revenueDetailCsvFileId: 8a8081ae5002967c015012f129a10926 revenueDetailExcelFileId: 8a8081ae5002967c015012f129870925 unprocessedChargesFileId: null fiscalYear: 2014 id: e20b074749d2a38b0149eac2e9550aa9 name: Oct 2014 notes: '' runTrialBalanceEnd: '2015-09-28 00:53:36' runTrialBalanceErrorMessage: null runTrialBalanceStart: '2015-09-28 00:53:13' runTrialBalanceStatus: Completed startDate: '2014-10-01' status: Closed success: true updatedBy: e20b074746ec48f40147140f51e30a1a updatedOn: '2015-09-28 00:53:13' schema: $ref: '#/components/schemas/GETAccountingPeriodType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an accounting period tags: - Accounting Periods put: description: | 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. operationId: PUT_UpdateAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period you want to update. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTAccountingPeriodType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/close: put: 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. operationId: PUT_CloseAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period you want to close. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Close an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/pending-close: put: description: | Sets an accounting period to pending close. 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 be closed or pending close. * The accounting period cannot be in the process of running a trial balance. * All earlier accounting periods must be closed. Notes ----- When 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. operationId: PUT_PendingCloseAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period you want to set to pending close. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Set an accounting period to pending close tags: - Accounting Periods /v1/accounting-periods/{ap-id}/reopen: put: 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. operationId: PUT_ReopenAccountingPeriod parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period that you want to re-open. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Reopen an accounting period tags: - Accounting Periods /v1/accounting-periods/{ap-id}/run-trial-balance: put: description: | Runs the trial balance for 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. See [Finance Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/f_Finance_Roles). Limitations ----------- * The accounting period must be open. * The accounting period cannot already be in the process of running a trial balance. Notes ----- The 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. operationId: PUT_RunTrialBalance parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: ID of the accounting period for which you want to run a trial balance. in: path name: ap-id required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Run trial balance tags: - Accounting Periods /v1/journal-entries: post: description: | This REST API reference describes how to manually create a summary journal entry. Request and response field descriptions and sample code are provided. ### Requirements 1.The sum of debits must equal the sum of credits in the summary journal entry. 2.The following applies only if you use foreign currency conversion: * If you have configured Aggregate transactions with different currencies during a Journal Run to "Yes", the value of the **currency** field must be the same as your tenant's home currency. That is, you must create journal entries using your home currency. * All journal entries in an accounting period must either all be aggregated or all be unaggregated. You cannot have a mix of aggregated and unaggregated journal entries in the same accounting period. operationId: POST_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTJournalEntryType' required: true responses: '200': content: application/json: examples: response: value: journalEntryNumber: JE-00000001 success: true schema: $ref: '#/components/schemas/POSTJournalEntryResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/journal-runs/{jr-number}: get: description: | This REST API reference describes how to retrieve information about all summary journal entries in a journal run. operationId: GET_AllSummaryJournalEntries parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize_finance_revenue' - description: Journal run number. in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: journalEntries: - accountingPeriodName: Dec'16 aggregateCurrency: true currency: USD homeCurrency: USD journalEntryDate: '2016-12-31' journalEntryItems: - accountingCodeName: Accounts Receivable accountingCodeType: AccountsReceivable amount: 100 glAccountName: Accounts Receivable glAccountNumber: 10-001-000-1234 homeCurrencyAmount: 100 type: Debit - accountingCodeName: Sales Revenue accountingCodeType: SalesRevenue amount: 100 glAccountName: Sales Revenue glAccountNumber: 10-001-000-1000 homeCurrencyAmount: 100 type: Credit notes: note number: JE-00000006 segments: - segmentName: Seg1 segmentValue: seg value status: Created timePeriodEnd: '2016-12-31' timePeriodStart: '2016-12-01' transactionType: Invoice Item transferredToAccounting: 'No' success: true schema: $ref: '#/components/schemas/GETJournalEntriesInJournalRunType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all summary journal entries in a journal run tags: - Summary Journal Entries /v1/journal-entries/{je-number}: delete: description: | This reference describes how to delete a summary journal entry using the REST API. You must have the "Delete Cancelled Journal Entry" user permission enabled to delete summary journal entries. A summary journal entry must be canceled before it can be deleted. operationId: DELETE_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Journal entry number in the format JE-00000001. in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a summary journal entry tags: - Summary Journal Entries get: description: | This REST API reference describes how to get information about a summary journal entry by its journal entry number. operationId: GET_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: '' in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: accountingPeriodName: Jan'16 aggregateCurrency: true currency: USD homeCurrency: USD journalEntryDate: '2016-01-31' journalEntryItems: - accountingCodeName: Deferred Revenue accountingCodeType: DeferredRevenue amount: 424.08 glAccountName: null glAccountNumber: null homeCurrencyAmount: 424.08 type: Debit - accountingCodeName: Professional Services Revenue accountingCodeType: SalesRevenue amount: 424.08 glAccountName: null glAccountNumber: null homeCurrencyAmount: 424.08 type: Credit notes: null number: JE-00000001 segments: - segmentName: Customer Code segmentValue: A00000001 - segmentName: Charge Type segmentValue: OneTime status: Created success: true timePeriodEnd: '2016-01-31' timePeriodStart: '2016-01-01' transactionType: Revenue Event Item transferDateTime: null transferredBy: null transferredToAccounting: null schema: $ref: '#/components/schemas/GETJournalEntryDetailType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/{je-number}/basic-information: put: description: | This REST API reference describes how to update the basic information of a summary journal entry. Request and response field descriptions and sample code are provided. operationId: PUT_BasicSummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Journal entry number in the format JE-00000001. in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTBasicSummaryJournalEntryType' required: true responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a summary journal entry tags: - Summary Journal Entries /v1/journal-entries/{je-number}/cancel: put: description: | This reference describes how to cancel a summary journal entry using the REST API. You must have the "Cancel Journal Entry" user permission enabled to cancel summary journal entries. A summary journal entry cannot be canceled if its Transferred to Accounting status is "Yes" or "Processing". operationId: PUT_SummaryJournalEntry parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: Journal entry number in the format JE-00000001. in: path name: je-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a summary journal entry tags: - Summary Journal Entries /v1/journal-runs: post: description: | This REST API reference describes how to create a journal run. Request and response field descriptions and sample code are provided. operationId: POST_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTJournalRunType' required: true responses: '200': content: application/json: examples: response: value: journalRunNumber: JR-00000008 success: true schema: $ref: '#/components/schemas/POSTJournalRunResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a journal run tags: - Journal Runs /v1/journal-runs/{jr-number}: delete: description: | This reference describes how to delete a journal run using the REST API. You can only delete journal runs that have already been canceled. You must have the "Delete Cancelled Journal Run" Zuora Finance user permission enabled to delete journal runs. operationId: DELETE_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Journal run number. Must be a valid journal run number in the format `JR-00000001`. in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a journal run tags: - Journal Runs get: description: | This REST API reference describes how to get information about a journal run. Request and response field descriptions and sample code are provided. operationId: GET_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Journal run number. Must be a valid journal run number in the format `JR-00000001`. in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: executedOn: '2014-11-15 22:05:12' journalEntryDate: '2016-02-02' number: JR-00000002 segmentationRuleName: s1 status: Completed success: true targetEndDate: '2016-03-31' targetStartDate: '2016-03-01' totalJournalEntryCount: 2 transactionTypes: - type: Invoice Item schema: $ref: '#/components/schemas/GETJournalRunType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a journal run tags: - Journal Runs /v1/journal-runs/{jr-number}/cancel: put: description: | This reference describes how to cancel a journal run using the REST API. The summary journal entries in the journal run are canceled asynchronously. See the "Example" section below for details. You must have the "Cancel Journal Run" Zuora Finance user permission enabled to cancel journal runs. ### Notes When you cancel a journal run, the summary journal entries associated with that journal run are canceled asynchronously. A response of `{ "success": true }` means only that the specified journal run has a status of "Pending", "Error", or "Completed" and therefore can be canceled, but does not mean that the whole journal run was successfully canceled. For example, let's say you want to cancel journal run JR-00000075. The journal run status is "Completed" and it contains ten journal entries. One of the journal entries has its Transferred to Accounting status set to "Yes", meaning that the entry cannot be canceled. The workflow might go as follows: 1. You make an API call to cancel the journal run. 2. The journal run status is "Completed", so you receive a response of `{ "success": true }`. 3. Zuora begins asynchronously canceling journal entries associated with the journal run. The journal entry whose Transferred to Accounting status is "Yes" fails to be canceled. The cancelation process continues, and the other journal entries are successfully canceled. 4. The journal run status remains as "Completed". The status does not change to "Canceled" because the journal run still contains a journey entry that is not canceled. operationId: PUT_JournalRun parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | Journal run number. Must be a valid journal run number in the format JR-00000001. You can only cancel a journal run whose status is "Pending", "Error", or "Completed". in: path name: jr-number required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a journal run tags: - Journal Runs /v1/bulk: post: description: | Describes how to perform a mass action through the REST API. Using this API method, you send a multipart/form-data request containing a `.csv` file with data about the mass action you want to perform. Zuora returns a key and then asynchronously processes the mass action. You can use the key to get details about the result of the mass action. If you want to use this operation to perform the Mass Payment Upload (MPU) mass action, see [Mass Payment Upload](https://knowledgecenter.zuora.com/Billing/Finance/Mass_Updater/Mass_Payment_Upload) for more information. operationId: POST_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: multipart/form-data: schema: properties: file: description: | File containing data about the mass action you want to perform. The file requirements are the same as when uploading a file through the Mass Updater in the Zuora UI. The file must be a `.csv` file or a zipped `.csv` file. The maximum file size is 4 MB. The data in the file must be formatted according to the mass action type you want to perform. format: binary type: string params: description: | Container for the following fields. You must format this parameter as a JSON object. * `actionType` (string, **Required**) - Type of mass action you want to perform. The following mass actions are supported: `UpdateAccountingCode`, `CreateRevenueSchedule`, `UpdateRevenueSchedule`, `DeleteRevenueSchedule`, `ImportFXRate`, and `MPU`. * `checksum` (string) - An MD5 checksum that is used to validate the integrity of the uploaded file. The checksum is a 32-character string. type: string required: - file - params type: object required: true responses: '200': content: application/json: examples: response: value: bulkKey: 402892f04c97b89a014c97bb30a50003 success: true schema: $ref: '#/components/schemas/POSTMassUpdateResponseType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Perform a mass action tags: - Mass Updater x-code-samples: - label: cURL lang: curl source: | curl -X POST -H "Authorization: Bearer f21f017e4724445d8647b1f0de7ed6f1" -F "file=@CreateRevenueSchedules.csv" -F "params="{\"actionType\": \"CreateRevenueSchedule\"}" "https://rest.zuora.com/v1/bulk" /v1/bulk/{bulk-key}: get: description: | Describes how to get information about the result of a mass action through the REST API. operationId: GET_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API. in: path name: bulk-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: actionType: UpdateAccountingCode endedOn: '2015-04-07 14:32:01' errorCount: 1 inputSize: 354 outputSize: 350 outputType: (url:.csv.zip) outputURL: https://rest.zuora.com/v1/files/402892c84c9285b1014c9293f5320007 processedCount: 3 startedOn: '2015-04-07 14:22:11' status: Completed success: true successCount: 2 totalCount: 3 uploadedBy: smith@example.com uploadedOn: '2015-04-07 14:22:09' schema: $ref: '#/components/schemas/GETMassUpdateType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all results of a mass action tags: - Mass Updater /v1/bulk/{bulk-key}/stop: put: description: | Describes how to stop a mass action through the REST API. You can stop a mass action when its status is Pending or Processing. After you have stopped a mass action, you can get the mass action result to see details of the mass action. - If you stop a mass action when its status is Pending, no response file is generated because no records have been processed. - If you stop a mass action when its status is Processing, a response file is generated. You can check the response file to see which records have been processed and which have not. In the response file, the **Success** column has the value `Y` (successful) or `N` (failed) for processed records, and a blank value for unprocessed records. Records that have already been processed when a mass action is stopped are not rolled back. operationId: PUT_MassUpdater parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API. in: path name: bulk-key required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: success: true schema: $ref: '#/components/schemas/CommonResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' 4XX: content: application/json: examples: response: value: processId: 738CBB9234B47A47 reasons: - code: '58730222' message: orderDate may not be null requestId: d7479cf6-b410-4630-b841-268ccd48f0d2 success: false schema: $ref: '#/components/schemas/CommonResponse' description: Request Errors headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: 'The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: string RateLimit-Remaining: description: 'The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number RateLimit-Reset: description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' schema: type: number Zuora-Request-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_RequestId' Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Stop a mass action tags: - Mass Updater /events/event-triggers: post: description: | When you create an event trigger, you must specify the base object and define the trigger condition. ### Specify the base object Use `baseObject` field to specify which object to define a trigger on. You can define an event trigger on any of the following objects: * Account * AccountingCode * AccountingPeriod * Amendment * BillingRun * Contact * CreditBalanceAdjustment * CreditMemo * CreditMemoApplication * CreditMemoApplicationItem * CreditMemoItem * CreditMemoPart * DebitMemo * DebitMemoItem * DeliveryAdjustment * Feature * Fulfillment * Fund * Invoice * InvoiceAdjustment * InvoiceItem * InvoiceItemAdjustment * JournalEntry * JournalEntryItem * Order * OrderAction * OrderLineItem * Payment * PaymentApplication * PaymentMethod * PaymentPart * PaymentSchedule * PaymentScheduleItem * Product * ProductFeature * ProductRatePlan * ProductRatePlanCharge * ProductRatePlanChargeTier * RatePlan * RatePlanCharge * RatePlanChargeTier * RatingResult * Refund * RefundApplication * RefundPart * RevenueEvent * RevenueEventItem * RevenueSchedule * RevenueScheduleItem * Subscription * SubscriptionChargeDeliverySchedule * SubscriptionChargePriceInterval * SubscriptionChargePriceIntervalTier * SubscriptionOffer * SubscriptionProductFeature * TaxationItem * UpdaterDetail * Usage * ValidityPeriodSummary In addition to the above Zuora standard objects, you can also use custom objects as base objects for custom events. #### Tenant level base objects and tenant level event triggers Zuora identifies the following base objects and custom objects as the tenant level base objects: * AccountingCode * AccountingPeriod * BillingRun * Feature * JournalEntry * JournalEntryItem * Product * ProductFeature * ProductRatePlan * ProductRatePlanCharge * ProductRatePlanChargeTier Event triggers defined on tenant level base objects are tenant level event triggers. Notifications associated with tenant level events are system notifications. **Note:** Tenant level event triggers and system notifications are only available in the default profile. ### Define the trigger condition The `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. **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. For example, the following condition causes an event to be triggered whenever an invoice is posted with an amount greater than 1000: ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0``` Where: * `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`. * `Invoice.Status` is the value of the Invoice object's `Status` field after the change occurred. * `Invoice.Status_old` is the value of the Invoice object's `Status` field before the change occurred. In the above example, the value of `baseObject` is `Invoice`. #### Limitations This event trigger has the following limitations: * Base object values for Zuora standard objects are case sensitive. For example, `PaymentMethod` is correct, and `Paymentmethod` or `paymentmethod` is incorrect. * Base object values for custom objects must be lowercase. For example, `default__vehicle`. * The INSERT change type is not supported on RatePlan base objects. * The INSERT change type is not supported on SubscriptionProductFeature base objects. * 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. * Fields on objects are case-sensitive. For example, `PaymentMethod.createdbyid` can result in errors. The correct format is `PaymentMethod.CreatedById`. * A condition cannot contain fields from data source objects that are joined to the base object. * 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. See [Custom Events](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Z_Custom_Events) for more information. operationId: POST_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostEventTriggerRequest' required: true responses: '200': content: application/json: examples: response: value: id: 5a70564ad08c412fb98e06a80c365c93 baseObject: Invoice condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 eventType: name: LargeInvoicePosted displayName: Large Invoice Posted namespace: user.notification active: true schema: $ref: '#/components/schemas/EventTrigger' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "reasons": [ { "code": "MissingRequiredField", "message": "eventType is missing" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an event trigger tags: - Custom Event Triggers get: operationId: GET_EventTriggers parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - 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`. in: query name: baseObject required: false schema: type: string - description: 'The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\w\-]*$' in: query name: eventTypeName required: false schema: type: string - description: The status of the event trigger. in: query name: active required: false schema: type: string - description: The first index of the query result. Default to 0 if absent, and the minimum is 0. in: query name: start required: false schema: default: 0 minimum: 0 type: integer - description: The maximum number of data records to be returned. Default to 10 if absent. in: query name: limit required: false schema: default: 10 minimum: 1 type: integer responses: '200': content: application/json: examples: response: value: data: - id: ac1ee535e8524858a72edb464212729d baseObject: Invoice condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 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 schema: properties: data: items: $ref: '#/components/schemas/EventTrigger' type: array next: description: The link to the next page. No value if it is last page. type: string type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "reasons": [ { "code": "FieldConstraintViolation", "message": "start should be >= 0" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List event triggers tags: - Custom Event Triggers /events/event-triggers/{id}: get: operationId: GET_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: response: value: id: ac1ee535e8524858a72edb464212729d baseObject: Invoice condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 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 schema: $ref: '#/components/schemas/EventTrigger' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an event trigger tags: - Custom Event Triggers put: description: '' operationId: PUT_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutEventTriggerRequest' required: true responses: '200': content: application/json: examples: response: value: id: 5a70564ad08c412fb98e06a80c365c93 baseObject: Invoice condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 description: Trigger the event when an invoice is posted with amount over 1000 eventType: name: LargeInvoicePosted displayName: Large Invoice Posted namespace: user.notification active: true schema: $ref: '#/components/schemas/EventTrigger' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an event trigger tags: - Custom Event Triggers delete: description: '' operationId: DELETE_EventTrigger parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - in: path name: id required: true schema: format: uuid type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "reasons": [ { "code": "ObjectNotFound", "message": "no event trigger found with the given id" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "reasons": [ { "code": "SystemError", "message": "internal server error" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an event trigger tags: - Custom Event Triggers /events/scheduled-events: post: description: | To create a custom scheduled event, you must specify the base object, the base field and the scheduled time. operationId: POST_ScheduledEvent parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/PostScheduledEventRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: FieldConstraintViolation message: name should follow ^[A-Za-z]{1,}[\w\-]*$ schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a scheduled event tags: - Custom Scheduled Events get: operationId: GET_ScheduledEvents parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: 'The name of the scheduled event. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$' in: query name: eventTypeName required: false schema: type: string - description: 'The base object that the scheduled event is defined upon. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' in: query name: apiObject required: false schema: type: string - description: 'The base field of the base object in the `apiObject` field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' in: query name: apiField required: false schema: type: string - description: Indicate whether the scheduled event is active or inactive. in: query name: active required: false schema: type: boolean - description: The first index of the query result. Default to 0 if absent, and the minimum is 0. in: query name: start required: false schema: default: 0 minimum: 0 type: integer - description: The maximum number of data records to be returned. Default to 10 if absent. in: query name: limit required: false schema: default: 10 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GetScheduledEventResponse' type: array next: description: The link to the next page. No value if it is last page. example: /events/scheduled-events?start=10&limit=10 type: string type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all scheduled events tags: - Custom Scheduled Events /events/scheduled-events/{id}: get: operationId: GET_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The ID of the scheduled event. in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: ResourceNotFound message: no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5 schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a scheduled event by ID tags: - Custom Scheduled Events put: operationId: UPDATE_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The ID of the scheduled event. in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PutScheduledEventRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetScheduledEventResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: FieldConstraintViolation message: name should follow ^[A-Za-z]{1,}[\w\-]*$ schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a scheduled event by ID tags: - Custom Scheduled Events delete: operationId: DELETE_ScheduledEventByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The ID of the scheduled event. in: path name: id required: true schema: type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: ResourceNotFound message: no resource found with the given identifier event-type by tenant id:10315 and id:59b8b0bfb3b94ce6a8fb96aed64d73c5 schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: SystemError message: internal server error schema: $ref: '#/components/schemas/ErrorResponse' description: Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a scheduled event by ID tags: - Custom Scheduled Events /notifications/notification-definitions: post: description: | Creates a notification definition. If a filter rule is specified, it will be evaluated to see if the notification definition is qualified to handle the incoming events during runtime. If the notification is qualified, it will send the email and invoke the callout if it has an email template or a callout. This operation supports creating notification definitions for all event types: - To create a notification definition for a standard event, you must specify the `eventCategory` field. For more information about standard event category codes, see Standard event category code for events and notifications. - To create a notification definition for a Zuora custom event, custom event, or custom scheduled event, you must specify the `eventTypeName` field. For more information, see Zuora custom events, [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/), and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/). You must specify either `eventCategory` or `eventTypeName`, but not both at the same time. operationId: POST_Create_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: examples: Create a notification definition: value: name: Account Edit Notification eventTypeName: AccountEdit emailActive: true emailTemplateId: f11e498862584a10a05b83ea70119659 communicationProfileId: 2c92c0f9446cd49501447539d6a72815 Create a notification definition with filter rules: value: name: Account Edit Notification eventTypeName: AccountEdit emailActive: true emailTemplateId: f11e498862584a10a05b83ea70119659 communicationProfileId: 2c92c0f9446cd49501447539d6a72815 filterRule: condition: Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS description: Filter rule to test if an account is a VIP account parameters: _ACCOUNT_STATUS: description: The status of the VIP Account displayName: VIP Account Status options: - Draft - Active - Canceled valueType: STRING _VIP_BALANCE_AMOUNT: description: The minimum account balance displayName: VIP Account Balance options: null valueType: BIG_DECIMAL filterRuleParams: _ACCOUNT_STATUS: Active _VIP_BALANCE_AMOUNT: '100000.0' schema: $ref: '#/components/schemas/POSTPublicNotificationDefinitionRequest' description: The request body used to create the notification definition. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ConstraintViolated", "message":"The email template is defined on a different EventType other than the notification's" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a notification definition tags: - Notifications get: description: | Queries notification definitions with the specified filters. operationId: GET_Query_Notification_Definitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true description: The first index of the query result. in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true description: The maximum number of results the query should return. in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true description: Id of the profile. in: query name: profileId schema: format: uuid type: string - description: | The event category code for a standard event, on which the notification definition is created. For the list of supported standard event category codes, see Standard event category code for events and notifications. You cannot specify `eventCategory` and `eventTypeName` at the same time. in: query name: eventCategory schema: type: number - allowEmptyValue: true description: | The name of the Zuora custom event, custom event, or custom scheduled event on which the notification definition is created. You cannot specify `eventCategory` and `eventTypeName` at the same time. in: query name: eventTypeName schema: type: string - allowEmptyValue: true description: The ID of the email template. in: query name: emailTemplateId schema: format: uuid type: string responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' type: array next: description: The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null. example: /notification-definitions?start=1&limit=10 type: string type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List notification definitions tags: - Notifications /notifications/notification-definitions/{id}: get: description: | Queries the notification definition of the given ID. operationId: GET_Get_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the notification definition. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: The Zuora request ID passed from the request or generated by the API Gateway. schema: type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a notification definition tags: - Notifications put: description: | Updates a notification definition. operationId: PUT_Update_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the notification definition to be updated. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicNotificationDefinitionRequest' description: The request body of the notification definition to be updated. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicNotificationDefinitionResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ConstraintViolated", "message":"The email template is defined on a different EventType other than the notification's" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a notification definition tags: - Notifications delete: description: | Deletes a notification definition. operationId: DELETE_Delete_Notification_Definition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the notification definition to be deleted. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"The notification definition with id 6e569e1e05f040eda51a927b140c0ac2 does not exist" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a notification definition tags: - Notifications /notifications/email-templates/import: post: description: | Creates email templates for standard or custom events if you do not specify email template IDs, or updates existing email templates if you specify valid email template IDs. For each email template when you are creating email templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the `eventCategory` or `eventTypeName` field. - If you specify the `eventCategory` field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes. - If you specify the `eventTypeName` field, the email template is created based on the corresponding custom event or custom scheduled event. See [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/) for more information about custom events, and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/) for more information about custom scheduled events. The maximum number of email templates that you can create or update by one call is 1,000. operationId: POST_CreateOrUpdateEmailTemplates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: examples: Create an email template: value: allowPartialSuccess: true emailTemplates: - active: true name: Account Edit Email eventTypeName: AccountEdit description: Details of the email template fromName: Company Co. Ltd. fromEmailType: TenantEmail toEmailType: BillToContact replyToEmailType: TenantEmail emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited emailBody: Dear user,

the account {{DataSource.Account.AccountNumber}} has been edited.

Company Co. Ltd. Update an email template: value: allowPartialSuccess: true emailTemplates: - id: f11e498862584a10a05b83ea70119659 name: Account Edit Email eventTypeName: AccountEdit description: Details of the email template fromName: Company Co. Ltd. fromEmailType: TenantEmail toEmailType: BillToContact replyToEmailType: TenantEmail emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited emailBody: Dear user,

the account {{DataSource.Account.AccountNumber}} has been edited.

Company Co. Ltd. schema: $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequest' description: The request body to import or update email templates. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create or update email templates tags: - Notifications /notifications/email-templates: post: description: | Creates an email template. This operation supports creating the email template for all event types. - If you specify the `eventCategory` field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes. - If you specify the `eventTypeName` field, the email template is created based on the corresponding custom event or custom scheduled event. See [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/) for more information about custom events, and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/) for more information about custom scheduled events. operationId: POST_Create_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicEmailTemplateRequest' description: The request body to create an email template. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"eventType {com.zuora.notification, AccountEdit} does not exist" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create an email template tags: - Notifications get: description: | Queries email templates. This operation supports querying email templates for all event types. operationId: GET_Query_Email_Templates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true description: The first index of the query result. in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true description: The maximum number of results the query should return. in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true description: The event category code for standard events. in: query name: eventCategory schema: type: number - allowEmptyValue: true description: The name of the custom event or custom scheduled event. in: query name: eventTypeName schema: type: string - allowEmptyValue: true description: The name of the email template. in: query name: name schema: type: string responses: '200': content: application/json: examples: response: value: data: - active: true bccEmailAddress: user@example.com ccEmailAddress: user@example.com ccEmailType: SpecificEmails createdBy: 6e569e1e05f040eda51a927b140c0ac3 createdOn: '2017-04-18T07:36:19.798Z' description: Email when an account is edited emailBody: Dear user,

the account has been edited.

Example Co. Ltd.

emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: Account has been edited encodingType: UTF8 eventTypeName: AccountEdit fromEmailType: TenantEmail fromName: Example Co. Ltd. id: 6e569e1e05f040eda51a927b140c0ac2 isHtml: true name: Account Edit Email replyToEmailType: TenantEmail toEmailAddress: DummyEmailAddress@example.com toEmailType: SpecificEmails updatedBy: 6e569e1e05f040eda51a927b140c0ac4 updatedOn: '2017-04-18T07:36:19.798Z' - active: true bccEmailAddress: user@example.com ccEmailAddress: user@example.com ccEmailType: SpecificEmails createdBy: 6e569e1e05f040eda51a927b140c0ac3 createdOn: '2017-04-18T07:37:20.798Z' description: Email when an invoice is posted emailBody: Dear user,

the invoice has been posted.

Example Co. Ltd.

emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: Invoice has been posted encodingType: UTF8 eventCategory: 1110 fromEmailAddress: EmailAddress1@example.com fromEmailType: SpecificEmail fromName: Example Co. Ltd. id: 6e569e1e05f040eda51a927b70e31f4e isHtml: true name: Invoice Posted Email replyToEmailType: TenantEmail toEmailType: BillToContact updatedBy: 6e569e1e05f040eda51a927b140c0ac4 updatedOn: '2017-04-18T07:37:20.798Z' next: /notification-definitions?start=1&limit=10 schema: properties: data: items: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' type: array next: description: The URI to query the next page of data, e.g. '/notification-definitions?start=1&limit=10'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null. type: string type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List email templates tags: - Notifications /notifications/email-templates/{id}: get: description: | Queries the email template based on the specified ID. This operation supports retrieving the email template for all event types. operationId: GET_Get_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the email template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: response: value: active: true bccEmailAddress: user@example.com ccEmailAddress: user@example.com ccEmailType: SpecificEmails createdBy: 6e569e1e05f040eda51a927b140c0ac3 createdOn: '2017-04-18T07:36:19.798Z' description: Email when an account is edited emailBody: Dear user,

the account has been edited.

Example Co. Ltd.

emailHeaders: My-Header-1: Header value 1 My-Header-2: Header value 2 emailSubject: Account has been edited encodingType: UTF8 eventTypeName: AccountEdit fromEmailType: TenantEmail fromName: Example Co. Ltd. id: 6e569e1e05f040eda51a927b140c0ac2 isHtml: true name: Account Edit Email replyToEmailType: TenantEmail toEmailAddress: DummyEmailAddress@example.com toEmailType: SpecificEmails updatedBy: 6e569e1e05f040eda51a927b140c0ac4 updatedOn: '2017-04-18T07:36:19.798Z' schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve an email template tags: - Notifications put: description: | Updates an email template. This operation supports updating the email template for all event types. operationId: PUT_Update_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the email template to be updated. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicEmailTemplateRequest' description: The request body to update an email template. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETPublicEmailTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"eventType {com.zuora.notification, AccountEdit} does not exist" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update an email template tags: - Notifications delete: description: | Deletes an email template. This operation supports deleting an email template for all event types. operationId: DELETE_Delete_Email_Template parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the email template to be deleted. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: |- { "code":"ObjectNotFound", "message":"The email template with id 6e569e1e05f040eda51a927b140c0ac2 does not exist in this tenant" } schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "code":"404", "message":"HTTP 404 Not Found" } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: |- { "code":"405", "message":"HTTP 405 Method Not Allowed" } schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: |- { "code":"415", "message":"HTTP 415 Unsupported Media Type" } schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: |- { "code":"500", "message":"A temporary problem in the service occurred, you can retry later." } schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete an email template tags: - Notifications /notifications/callout-templates/import: post: summary: Create or update callout templates operationId: CreateOrUpdateCalloutTemplates tags: - Notifications description: | Creates callout templates for standard or custom events if you do not specify callout template IDs, or updates existing callout templates if you specify valid callout template IDs. For each callout template when you are creating callout templates, whether the template is created for a standard event, a custom event, or a custom scheduled event is dependent on whether you specify the `eventCategory` or `eventTypeName` field. - If you specify the `eventCategory` field, the callout template is created based on a standard event. See Standard event category code for events and notifications for all standard event category codes. - If you specify the `eventTypeName` field, the callout template is created based on the corresponding custom event, Zuora custom event, or custom scheduled event. See [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/) for more information about custom events, and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/) for more information about custom scheduled events. The maximum number of callout templates that you can create or update by one call is 1,000. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequest' description: The request body to import or update callout templates. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateEmailTemplatesResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/callout-templates: post: summary: Create a callout template operationId: CreateCalloutTemplate tags: - Notifications description: | Creates a callout template. This operation supports creating the callout template for all event types: - To create a callout template for a standard event, you must specify the `eventCategory` field. For more information about standard event category codes, see Standard event category code for events and notifications. - To create a callout template for a Zuora custom event, custom event, or custom scheduled event, you must specify the `eventTypeName` field. For more information, see Zuora custom events, [Custom event triggers](https://developer.zuora.com/api-references/api/tag/Custom-Event-Triggers/), and [Custom scheduled events](https://developer.zuora.com/api-references/api/tag/Custom-Scheduled-Events/). You must specify either `eventCategory` or `eventTypeName`, but not both at the same time. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTPublicCalloutTemplateRequest' examples: Callout - Without authentication: value: name: Account Edit eventTypeName: AccountEdit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST Callout - Base authentication: value: name: Account Edit eventTypeName: AccountEdit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST requiredAuth: true calloutAuth: username: name password: pw123 Callout - OAuth 2.0 authentication: value: name: Account Edit eventTypeName: AccountEdit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST requiredOauth2: true oauth2ProviderId: 8ad099a98b94d51e018ba3beb9ed6c29 description: The request body to create a callout template. required: true responses: '200': content: application/json: examples: response: value: id: dcc5a61ee76e496c984206131b5b83e7 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2024-06-17T04:07:13.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2024-06-17T04:07:13.000 UTC eventTypeName: AccountEdit eventTypeNamespace: user.notification name: Account Edit description: Callout when an account is edited active: true calloutBaseurl: https://www.example.com/callout/AccountEdit calloutParams: null calloutHeaders: null httpMethod: POST requiredAuth: false calloutAuth: null requiredOauth2: false oauth2ProviderId: null calloutRetry: true contentType: APPLICATION_JSON useCustomRequestBody: false customRequestBody: null certificate: null hmacKey: null hmacValue: null hmacData: null hmacAlgorithm: null hmacSecret: null hmacOutputFormat: null schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '415' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' get: summary: List callout templates operationId: GetCalloutTemplates tags: - Notifications description: | Queries callout templates. This operation supports querying callout templates for all event types. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true description: The first index of the query result. in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true description: The maximum number of results the query should return. in: query name: limit schema: default: 20 format: int32 maximum: 100 minimum: 1 type: integer - allowEmptyValue: true description: The event category code of a standard event to which the callout templates you want to query relates. in: query name: eventCategory schema: type: number - allowEmptyValue: true description: | The name of a Zuora custom event, custom event, or custom scheduled event to which the callout templates you want to query relates. in: query name: eventTypeName schema: type: string - allowEmptyValue: true description: The name of the callout template. in: query name: name schema: type: string responses: '200': content: application/json: examples: response: value: data: - id: dcc5a61ee76e496c984206131b5b83e7 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2024-06-17T04:07:13.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2024-06-17T04:07:13.000 UTC eventTypeName: AccountEdit eventTypeNamespace: user.notification name: Account Edit description: Callout when an account is edited active: true calloutBaseurl: https://www.example.com/callout/AccountEdit calloutParams: null calloutHeaders: null httpMethod: POST requiredAuth: false calloutAuth: null requiredOauth2: false oauth2ProviderId: null calloutRetry: true contentType: APPLICATION_JSON useCustomRequestBody: false customRequestBody: null certificate: null hmacKey: null hmacValue: null hmacData: null hmacAlgorithm: null hmacSecret: null hmacOutputFormat: null - id: a745b9dd39154591b6cc618465aeb133 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2024-06-17T04:09:03.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2024-06-17T04:09:03.000 UTC eventTypeName: AccountDelete eventTypeNamespace: user.notification name: Account Delete description: Callout when an account is deleted active: true calloutBaseurl: https://www.example.com/callout/AccountDelete calloutParams: null calloutHeaders: null httpMethod: POST requiredAuth: false calloutAuth: null requiredOauth2: false oauth2ProviderId: null calloutRetry: true contentType: APPLICATION_JSON useCustomRequestBody: false customRequestBody: null certificate: null hmacKey: null hmacValue: null hmacData: null hmacAlgorithm: null hmacSecret: null hmacOutputFormat: null next: /notifications/callout-templates?start=21&limit=20 schema: type: object properties: data: items: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' type: array next: description: | The URI to query the next page of data, e.g. '/notifications/callout-templates?start=21&limit=20'. The start equals request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null. type: string description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '415' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/callout-templates/{id}: get: summary: Retrieve a callout template operationId: GetCalloutTemplte tags: - Notifications description: | Queries the callout template based on the specified ID. This operation supports retrieving the callout template for all event types. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the callout template. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: response: value: id: dcc5a61ee76e496c984206131b5b83e7 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2024-06-17T04:07:13.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2024-06-17T04:07:13.000 UTC eventTypeName: AccountEdit eventTypeNamespace: user.notification name: Account Edit description: Callout when an account is edited active: true calloutBaseurl: https://www.example.com/callout/AccountEdit calloutParams: null calloutHeaders: null httpMethod: POST requiredAuth: false calloutAuth: null requiredOauth2: false oauth2ProviderId: null calloutRetry: true contentType: APPLICATION_JSON useCustomRequestBody: false customRequestBody: null certificate: null hmacKey: null hmacValue: null hmacData: null hmacAlgorithm: null hmacSecret: null hmacOutputFormat: null schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '415' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' put: summary: Update a callout template operationId: UpdateCalloutTemplate tags: - Notifications description: Updates a callout template. This operation supports updating the callout template for all event types. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the callout template to be updated. in: path name: id required: true schema: format: uuid type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PUTPublicCalloutTemplateRequest' examples: Callout - Without authentication: value: name: Account Edit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST Callout - Base authentication: value: name: Account Edit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST requiredAuth: true calloutAuth: username: name password: pw123 Callout - OAuth 2.0 authentication: value: name: Account Edit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST requiredOauth2: true oauth2ProviderId: 8ad099a98b94d51e018ba3beb9ed6c29 description: The request body to update a callout template. required: true responses: '200': content: application/json: examples: response: value: id: dcc5a61ee76e496c984206131b5b83e7 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2024-06-17T04:07:13.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2024-06-17T04:07:13.000 UTC eventTypeName: AccountEdit eventTypeNamespace: user.notification name: Account Edit description: Callout when an account is edited active: true calloutBaseurl: https://www.example.com/callout/AccountEdit calloutParams: null calloutHeaders: null httpMethod: POST requiredAuth: false calloutAuth: null requiredOauth2: false oauth2ProviderId: null calloutRetry: true contentType: APPLICATION_JSON useCustomRequestBody: false customRequestBody: null certificate: null hmacKey: null hmacValue: null hmacData: null hmacAlgorithm: null hmacSecret: null hmacOutputFormat: null schema: $ref: '#/components/schemas/GETPublicCalloutTemplateResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '415' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' delete: summary: Delete a callout template operationId: DeleteCalloutTemplate tags: - Notifications description: Deletes a callout template. This operation supports deleting a callout template for all event types. parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the callout template to be deleted. in: path name: id required: true schema: format: uuid type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '415' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /notifications/reusable-blocks/import: post: description: | Creates reusable blocks if you do not specify block IDs, or updates existing reusable blocks if you specify valid block IDs. All fields must be provided for each reusable block you want to update. The maximum number of reusable blocks that you can create or update by one call is 1,000. operationId: createOrUpdateReusableBlocks parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: examples: Create a reusable block: value: allowPartialSuccess: true reusableBlocks: - name: Footer Block category: Footers content: (The content of the block) Update a reusable block: value: allowPartialSuccess: true reusableBlocks: - id: 385bcf09b2aa4a628098a88f62552180 active: true name: Header Block number: RB-00000010 category: Headers tags: - logo content: (The content of the block) schema: $ref: '#/components/schemas/CreateOrUpdateReusableBlockRequest' description: The request body to import or update reusable blocks. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CreateOrUpdateReusableBlockResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create or update reusable blocks tags: - Notifications /notifications/reusable-blocks: post: description: | Creates a reusable block for email templates, such as email headers or footers. operationId: createReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublicReusableBlockRequest' description: The request body to create a reusable block. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetPublicReusableBlockResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '500' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create a reusable block tags: - Notifications get: description: | Queries reusable blocks. operationId: getReusableBlocks parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - allowEmptyValue: true description: The first index of the query result. in: query name: start schema: default: 1 format: int32 type: integer - allowEmptyValue: true description: The maximum number of results the query should return. in: query name: limit schema: default: 20 format: int32 maximum: 5000 minimum: 1 type: integer - allowEmptyValue: true description: Whether to return only active reusable blocks. in: query name: activeOnly schema: type: boolean default: true - allowEmptyValue: true description: The category that the returned blocks belong to. in: query name: category schema: type: string enum: - Headers - Footers - Other - allowEmptyValue: true description: The name of the block the query should return. in: query name: name schema: type: string - allowEmptyValue: true description: The tags the returned blocks are associated with. If multiple tags are specified, only blocks that match all specified tags are returned. in: query name: tag schema: type: array items: type: string responses: '200': content: application/json: examples: response: value: next: /notifications/reusable-blocks?start=21&limit=20 data: - id: c6af751e4a0041eebb000c51e95e6c2d createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2025-04-22T08:17:24.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2025-04-22T08:17:24.000 UTC active: true name: Header Block number: RB-00000010 category: Headers tags: [] content: (The content of the block) - id: 385bcf09b2aa4a628098a88f62552180 createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2025-04-17T03:36:39.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2025-04-22T08:55:07.000 UTC active: true name: Footer Block number: RB-00000009 category: Footers tags: [] content: (The content of the block) schema: properties: data: items: $ref: '#/components/schemas/GetPublicReusableBlockResponse' type: array next: description: | The URI to query the next page of data, e.g. '/notifications/reusable-blocks?start=21&limit=20'. The start equals the request's start+limit, and the limit equals the request's limit. If the current page is the last page, this value is null. type: string type: object description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '500' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List reusable blocks tags: - Notifications /notifications/reusable-blocks/{blockKey}: get: description: | Queries the reusable block based on the specified ID or name. operationId: getReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or name of the reusable block. in: path name: blockKey required: true schema: type: string responses: '200': content: application/json: examples: response: value: id: c6af751e4a0041eebb000c51e95e6c2d createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2025-04-22T08:17:24.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2025-04-22T08:17:24.000 UTC active: true name: Header Block number: RB-00000010 category: Headers tags: [] content: (The content of the block) schema: $ref: '#/components/schemas/GetPublicReusableBlockResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: schema: maxLength: 64 type: string '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '500' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a reusable block tags: - Notifications put: description: | Updates a reusable block. operationId: updateReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or name of the reusable block. in: path name: blockKey required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublicReusableBlockRequest' description: The request body to update a reusable block. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UpdatePublicReusableBlockResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '500' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a reusable block tags: - Notifications delete: description: | Deletes a reusable block. operationId: deleteReusableBlock parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID or name of the reusable block. in: path name: blockKey required: true schema: type: string responses: '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: reasons: - code: ObjectNotFound message: eventType {com.zuora.notification, AccountEdit} does not exist schema: $ref: '#/components/schemas/ErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: reasons: - code: '404' message: HTTP 404 Not Found schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '405': content: application/json: examples: response: value: reasons: - code: '405' message: HTTP 405 Method Not Allowed schema: $ref: '#/components/schemas/ErrorResponse' description: Method Not Allowed headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: reasons: - code: '415' message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/ErrorResponse' description: Unsupported Media Type headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: examples: response: value: reasons: - code: '500' message: A temporary problem in the service occurred, you can retry later. schema: $ref: '#/components/schemas/ErrorResponse' description: Internal Server Error headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a reusable block tags: - Notifications /notifications/history: delete: description: | Delete all notification histories for the given account. All email and callout notifications for this account will be deleted upon successful operation. operationId: DELETE_Delete_Notification_History_For_Account parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: The ID of the account whose notification histories are to be deleted. in: query name: accountId required: true schema: format: uuid type: string responses: '202': content: application/json: examples: response: value: |- { "id": "2be2f02afc504d1b83fb3cd095ce4dc6", "status": "RUNNING", "tenantId": "9", "createdBy": "402881e522cf4f9b0122cf5d82860002", "createdOn": 1610358627000, "accountId": "2c9e8084769a87be0176f0cfa138001e" } schema: $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse' description: Accepted headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: description: The error message notifying that `accountId` must not be empty. example: may not be null (path = PublicNotificationHistoryResource.deleteHistoryByAccountId.query param accountId, invalidValue = null) type: string description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "reasons": [ { "code": "404", "message": "HTTP 404 Not Found" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete notification histories for an account tags: - Notifications x-code-samples: - label: Curl lang: curl source: | curl -X DELETE -H "Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3" -H "Content-Type: application/json" "https://rest.zuora.com//notifications/history?accountId=402892c74c9193cd014c96bbe7c101f9" /notifications/history/tasks/{id}: get: description: | Get the notification history deletion task by ID. operationId: GET_Get_Notification_History_Deletion_Task parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - description: | The ID of the notification history deletion task. You can get the deletion task ID from the 202 response body of the [Delete notification histories for an account](https://developer.zuora.com/api-references/api/operation/DELETE_Delete_Notification_History_For_Account) operation. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: response: value: |- { "id": "2be2f02afc504d1b83fb3cd095ce4dc6", "status": "FINISHED", "tenantId": "9", "createdBy": "402881e522cf4f9b0122cf5d82860002", "createdOn": 1610358627000, "accountId": "2c9e8084769a87be0176f0cfa138001e" } schema: $ref: '#/components/schemas/NotificationsHistoryDeletionTaskResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: |- { "reasons": [ { "code": "ObjectNotFound", "message": "history task with id 2be2f02afc504d1b83fb3cd095ce4dc7 not found" } ] } schema: $ref: '#/components/schemas/ErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a notification history deletion task tags: - Notifications /notifications/callout-histories/resend: post: description: | Resends callout notifications if your customers did not receive previous callout notifications. Details about the status codes and response contents of this operation are as follows: | Scenario | Status code | Response content | |----------------------------------------|-----------------|-------------------------------------------------------------| | Success for all notifications | 202 Accepted | (blank) | | Success for at least one notification | 202 Accepted | Error code and error message of each failed notification | | Failure for all notifications | 400 Bad Request | Error code and error message of each failed notification | operationId: POST_ResendCalloutNotifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTResendCalloutNotifications' description: The request body to resend callout notifications. required: true responses: '202': content: application/json: examples: response: value: a00000000000000000000000000000000: code: ObjectNotFound message: Callout history does not exist. schema: $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse' description: Accepted headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: a00000000000000000000000000000000: code: ObjectNotFound message: Callout history does not exist. a00000000000000000000000000000001: code: ObjectNotFound message: Callout history does not exist. schema: $ref: '#/components/schemas/ResendCalloutNotificationsFailedResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resend callout notifications tags: - Notifications /notifications/email-histories/resend: post: description: | Resends email notifications if your customers did not receive previous email notifications. Details about the status codes and response contents of this operation are as follows: | Scenario | Status code | Response content | |----------------------------------------|-----------------|-------------------------------------------------------------| | Success for all notifications | 202 Accepted | (blank) | | Success for at least one notification | 202 Accepted | Error code and error message of each failed notification | | Failure for all notifications | 400 Bad Request | Error code and error message of each failed notification | operationId: POST_ResendEmailNotifications parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' requestBody: content: application/json: schema: $ref: '#/components/schemas/POSTResendEmailNotifications' description: The request body to resend email notifications. required: true responses: '202': content: application/json: examples: response: value: a00000000000000000000000000000000: code: ObjectNotFound message: Email history does not exist. schema: $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse' description: Accepted headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: a00000000000000000000000000000000: code: ObjectNotFound message: Email history does not exist. a00000000000000000000000000000001: code: ObjectNotFound message: Email history does not exist. schema: $ref: '#/components/schemas/ResendEmailNotificationsFailedResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Resend email notifications tags: - Notifications /v1/notification-history/callout: get: description: | Describes how to get a notification history for callouts. operationId: GET_CalloutHistory parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. in: query name: endTime required: false schema: format: date-time type: string - description: The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. in: query name: startTime required: false schema: format: date-time type: string - description: | The ID of an object that triggered a callout notification. in: query name: objectId required: false schema: type: string - description: | If `true`, only return failed records. If `false`, return all records in the given date range. The default value is `true`. in: query name: failedOnly required: false schema: type: boolean - description: | Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if the Custom Events feature is enabled in your tenant. For example: `user.notification:NewSubscriptionCreated`. * Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, `1210`. See [Event Category Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information. in: query name: eventCategory required: false schema: type: string - description: '' in: query name: includeResponseContent required: false schema: type: boolean - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: calloutHistories: - attemptedNum: 3 createTime: '2015-01-13T03:33:51' eventCategory: 1210 eventContext: : USD : $ : 402881e54ade80c8014ade884c48000b : test : A00000001 : Mary : 402881e54ade80c8014ade884c51000c : Smith : smith@example.com : 402881e54ade80c8014ade884c48000b : 402881e54ade80c8014ade884c51000c : SubscriptionCreated : 402892fa47866fe701478674a4ff0093 : 2015-01-13T22:31:43.248+0800 : EmailTemplate: New Subscription Created Default Email Template Event: New Subscription Created Profile: Default Profile calloutAction: true emailAction: true id: 402892fa47866fe701478674a5c100eb updatedBy: 402892fa47866fe7014786749d9b0002 updatedOn: 01/12/2015 03:23:08 : 402881e54ae37f31014ae3b514e100fd : 'No' : $250.00 : 01/01/2016 : 01/13/2015 : smith@example.com : 01/01/2016 : 402881e54ae37f31014ae3b514e100fd : '50' : '0' : 01/01/2016 : Charge Name: recurringcharge Charge Type: Recurring Effective Start Date: 01 / 01 / 2016 QTY: 5 Total: 250 Unit Price: 50 : A-S00000003 : $12,500.00 : 03/01/2020 : termed : 01/01/2016 notification: New Subscription Created requestMethod: POST requestUrl: https://www.google.com responseCode: 405 nextPage: https://localhost:8080/apps/v1/notification-history/callout?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000 success: true schema: $ref: '#/components/schemas/GETCalloutHistoryVOsType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: List callout notification histories tags: - Notifications /v1/notification-history/email: get: description: | Describes how to get a notification history for notification emails. ### Notes Request parameters and their values may be appended with a "?" following the HTTPS GET request. Additional request parameter are separated by "&". For example: `GET https://rest.zuora.com/v1/notification-history/email?startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000&pageSize=1` operationId: GET_EmailHistory parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_REQUEST_page' - $ref: '#/components/parameters/GLOBAL_REQUEST_pageSize' - description: ID of an account. By specifying this query parameter, you can filter email notification histories by account. in: query name: accountId schema: type: string - description: The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days. in: query name: endTime required: false schema: format: date-time type: string - description: The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime - startTime) is three days. in: query name: startTime required: false schema: format: date-time type: string - description: | The Id of an object that triggered an email notification. in: query name: objectId required: false schema: type: string - description: | If `true`, only returns failed records. When `false`, returns all records in the given date range. Defaults to `true` when not specified. in: query name: failedOnly required: false schema: type: boolean - description: | Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if the Custom Events feature is enabled in your tenant. For example: `user.notification:NewSubscriptionCreated`. * Numeric code of the event category if the Custom Events feature is not enabled in your tenant. For example, `1210`. See [Event Category Code](https://knowledgecenter.zuora.com/DC_Developers/AA_REST_API/Event_Categories_for_Notification_Histories) for more information. in: query name: eventCategory required: false schema: type: number - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: emailHistories: - accountId: 2c9e8084769a87be0176f0cfa138001e bcc: ceo@example.com,cto@example.com cc: bob@example.com,chris@example.com errorMessage: null eventCategory: 1210 fromEmail: no-reply@example.com notification: New Subscription Created replyTo: supportexample.com result: OK sendTime: '2015-01-13T03:31:43' subject: New subscription A-S00000003 was created and activated toEmail: smith@example.com nextPage: https://localhost:8080/apps/v1/notification-history/email?page=2&pageSize=1&startTime=2015-01-12T00:00:00&endTime=2015-01-15T00:00:00&failedOnly=false&eventCategory=1000 success: true schema: $ref: '#/components/schemas/GETEmailHistoryVOsType' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: List email notification histories tags: - Notifications /objects/definitions/default: post: 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\t64.\n* The maximum number of characters for the custom field Description\tis 250.\n* The maximum number of picklist or multiselect options is 250.\n* The maximum length of characters for the Text field is 255.\n* The maximum length of characters for the Long Text field is from 256 to 8,192.\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" operationId: POST_CustomObjectDefinitions parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequest' description: The custom object definitions to be created required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create custom object definitions tags: - Custom Object Definitions get: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: | If you set `select` to `type`, the response will only contain the `type` of each custom object. in: query name: select required: false schema: enum: - type type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GETAllCustomObjectDefinitionsInNamespaceResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List custom object definitions tags: - Custom Object Definitions /objects/migrations: post: description: | Updates a custom object definition by posting migration resource to initiate the migration of definitions. ### Limitations Updating custom field definition has the following limitations: * You can only have one action per update request. * You cannot delete fields from custom objects that contain records. * You can only add required fields to custom objects with no records. * You can change optional fields to required only on the custom objects with no records. ### Note The bulk deletion of custom fields on standard and custom objects is temporarily unavailable as we refine the Custom Field feature. You can still delete custom fields individually during this refinement process. If you want to delete multiple custom fields, ensure that you send each deletion request only after receiving the response for the previous request. The bulk deletion capability will be restored once the refinement is complete. operationId: POST_UpdateCustomObjectDefinition parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationUpdateCustomObjectDefinitionsRequest' description: Migration resource for object and namespace changes. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/MigrationUpdateCustomObjectDefinitionsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a custom object definition tags: - Custom Object Definitions /objects/definitions/default/{object}: get: description: | Retrieves the custom object definition by type for the given tenant. operationId: GET_CustomObjectDefinitionByType parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectDefinition' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Resource Request-URI not found. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object definition tags: - Custom Object Definitions delete: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string responses: '200': content: application/json: schema: description: The URI of the deleted custom object definition example: /objects/definitions/default/test_custom_object format: uri type: string description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a custom object definition tags: - Custom Object Definitions /objects/records/default/{object}: post: description: | Creates custom object records with the given type. Upon creating records of a custom object type, the 200 response contains a list of records that have been successfully processed and stored. ### Limitations This call has the following limitations: * The maximum number of records that you can create by one call is 1,000. * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ``` { "records": [ { "fieldName__c": null } ] } ``` * When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications.
If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization. operationId: POST_CustomObjectRecords parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string requestBody: content: application/json: examples: Partial success turned off: value: records: - DeviceId__c: '10101010' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d Partial success turned on: value: allowPartialSuccess: true records: - DeviceId__c: '10101010' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d - DeviceId__c: '10101011' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d schema: $ref: '#/components/schemas/PostCustomObjectRecordsRequest' required: true responses: '200': content: application/json: examples: Partial success turned off: value: records: - Id: 9ef0b1a0-e398-46aa-856f-76273b0d2988 type: Vehicle DeviceId__c: '10101010' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d CreatedById: 8ad084a67f9c7138017fab8a8b511b5a UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a CreatedDate: '2024-07-09T06:41:17.377Z' UpdatedDate: '2024-07-09T06:41:17.377Z' unprocessedRecords: [] Partial success turned on: value: error: code: 71012520 message: Request contains invalid record that failed validation against the object schema. details: - code: 71012526 message: 'Json input does not match schema. Error: Field [DeviceId__c] should be string type but received integer.' record: Id: 6d96fbde-213c-43c3-bbef-9b777b050a94 DeviceId__c: '10101011' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d records: - Id: 9ef0b1a0-e398-46aa-856f-76273b0d2988 type: Vehicle DeviceId__c: '10101010' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d CreatedById: 8ad084a67f9c7138017fab8a8b511b5a UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a CreatedDate: '2024-07-09T06:41:17.377Z' UpdatedDate: '2024-07-09T06:41:17.377Z' unprocessedRecords: [] schema: $ref: '#/components/schemas/PostCustomObjectRecordsResponse' 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: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' description: Failed schema validation headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse401Record' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse' description: Internal error. Retry the returned records. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Create custom object records tags: - Custom Object Records get: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string - 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 name: q required: false schema: type: string - 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 name: ids required: false schema: type: string - description: The number of records returned per page in the response. in: query name: pageSize required: false schema: maximum: 1000 minimum: 1 type: integer - 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 name: cursor required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/QueryCustomObjectRecordsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List records for a custom object tags: - Custom Object Records /objects/records/default/{object}/{id}: get: description: | Retrieves a record of a given type by ID. operationId: GET_CustomObjectRecordByID parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string - description: Id identifier in uuid form in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Not exist headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object record tags: - Custom Object Records put: description: | Updates a record of the given type and ID. ### Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ``` { "records": [ { "fieldName__c": null } ] } ``` * When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications.
If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization. operationId: PUT_CustomObjectRecord parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_If_Match' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string - description: Id identifier in uuid form in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Object record does not exist headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update a custom object record tags: - Custom Object Records patch: 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). ### Limitations * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ``` { "records": [ { "fieldName__c": null } ] } ``` * When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications.
If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization. operationId: Patch_PartialUpdateCustomObjectRecord parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string - description: Id identifier in uuid form in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string requestBody: content: application/merge-patch+json: schema: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: schema: $ref: '#/components/schemas/CommonResponse' description: Object record does not exist headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Partially update a custom object record tags: - Custom Object Records delete: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string - description: Id identifier in uuid form in: path name: id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: schema: description: The URI of the deleted custom object record. example: /objects/records/default/test_custom_object/3a437f0b-fa7a-45bf-a9a5-2187a5a13ec0 format: uri type: string description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Delete a custom object record tags: - Custom Object Records /objects/batch/default/{object}: post: description: | Makes a batch update or delete of custom object records. ### Limitations This call has the following limitations: * The maximum number of records that you can update by one call is 1,000. * The maximum number of records that you can delete by one call is 1,000. * The storage of empty strings in records is not supported. * Null values must be formatted as the following example: ``` { "action": { "type": "update", "records": { "64edb2a5-2796-4e95-9559-846f8636a01b": { "fieldName__c": null } } } } ``` * When creating or updating custom object records with relationship-type fields, Zuora verifies the related objects against the transactional databases, which are updated in near real-time. The record creation or modification fails upon unsuccessful verifications.
If the related objects are newly created in your tenant, it might need some time for the transactional database synchronization. operationId: POST_CustomObjectRecordsBatchUpdateOrDelete parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: Specifies the custom object's API name as object. It is case-sensitive. in: path name: object required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordBatchRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsBatchUpdatePartialSuccessResponse' 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: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' 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: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse401Record' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '500': content: application/json: schema: $ref: '#/components/schemas/CustomObjectRecordsThrottledResponse' description: Internal error. Retry the returned records. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Update or delete custom object records tags: - Custom Object Records /objects/jobs: post: 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. ### Limits This custom object bulk jobs have the following limits: * 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. * The bulk job execuation order is not guaranteed, which means the bulk job that you submit ealier may be executed later. * 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. operationId: POST_CustomObjectBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobRequest' description: Custom Objects bulk job request required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: code: 71013020 message: Bad Request schema: $ref: '#/components/schemas/CommonResponse' description: Invalid input headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: examples: response: value: code: 71012514 message: User does not have permission to delete custom objects. schema: $ref: '#/components/schemas/CommonResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Submit a custom object bulk job tags: - Custom Object Jobs get: description: | Lists all custom object bulk jobs submitted by your tenant. operationId: GET_AllCustomObjectBulkJobs parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: The number of records returned per page in the response. in: query name: pageSize required: false schema: default: 25 maximum: 100 type: integer - 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 name: cursor required: false schema: type: string - description: The status of bulk jobs to be retrieved. in: query name: status required: false schema: enum: - pending - accepted - in_progress - completed - failed - cancelled type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponseCollection' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all custom object bulk jobs tags: - Custom Object Jobs x-code-samples: - label: Curl lang: 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: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: The ID of the custom object bulk job to be retrieved. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: code: 71013040 message: Not Found. schema: $ref: '#/components/schemas/CommonResponse' description: Bulk job not found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a custom object bulk job tags: - Custom Object Jobs /objects/jobs/{id}/files: post: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: The `Content-Type` of the request must be `text/csv`. in: header name: Content-Type required: true schema: type: string - description: The ID of the custom object bulk job that the file is uploaded to. in: path name: id required: true schema: format: uuid type: string requestBody: content: text/csv: schema: description: The CSV file to be uploaded. The file must be encoded in UTF-8 and the file size limit is 15 MB. type: string required: true responses: '200': content: application/json: examples: response: value: CreatedById: 2c92c0f96a07409d016a0a58ab1172ec CreatedDate: '2021-03-10T00:05:54.207Z' Id: 5112347a-f7a1-4373-99df-c082984de7be UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec UpdatedDate: '2021-03-10T00:08:15.539Z' namespace: default object: vehicle operation: create processingTime: 0 recordsProcessed: 0 status: in_progress schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: code: 71013620 message: Bad Request schema: $ref: '#/components/schemas/CommonResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: examples: response: value: code: 71012515 message: User does not have permission to create custom objects. schema: $ref: '#/components/schemas/CommonResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: code: 71013040 message: Not Found. schema: $ref: '#/components/schemas/CommonResponse' description: Job not found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Upload a file for a custom object bulk job tags: - Custom Object Jobs x-code-samples: - label: Curl lang: 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: description: | Lists all errors for a custom object bulk job. operationId: GET_CustomObjectBulkJobErrors parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: The ID of the custom object bulk job that you retrieve errors for. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomObjectBulkJobErrorResponseCollection' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: code: 71013040 message: Not Found. schema: $ref: '#/components/schemas/CommonResponse' description: Job not found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List all errors for a custom object bulk job tags: - Custom Object Jobs /objects/jobs/{id}/cancel: patch: 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 parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - 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. in: header name: Zuora-Version required: false schema: format: date type: string - description: The ID of the custom object bulk job that you want to cancel. in: path name: id required: true schema: format: uuid type: string responses: '200': content: application/json: examples: response: value: CreatedById: 11e64eef-ada8-786d-9658-00259058c29c CreatedDate: '2022-12-01T21:24:04.337Z' Id: 7f19b861-5ec7-479b-935c-fcfbd6477655 UpdatedById: 0fdfc048-0a9e-433f-ad23-d50e31448b2e UpdatedDate: '2022-12-01T21:37:43.212Z' namespace: default object: jobtest operation: create processingTime: 0 recordsProcessed: 0 status: cancelled schema: $ref: '#/components/schemas/CustomObjectBulkJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: code: 71013620 message: Bad Request schema: $ref: '#/components/schemas/CommonResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: code: 71013040 message: Job not found for id '7006ce52-91c9-11ed-a1eb-0242ac120002'. schema: $ref: '#/components/schemas/CommonResponse' description: Job not found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a custom object bulk job tags: - Custom Object Jobs /query/jobs: get: 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. operationId: GET_DataQueryJobs parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Filters the list of query jobs by status. in: query name: queryStatus required: false schema: enum: - accepted - in_progress - completed - failed - cancelled type: string - description: | The number of records returned per page in the response. in: query name: pageSize required: false schema: default: 20 maximum: 1000 type: integer responses: '200': content: application/json: examples: response: value: data: - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 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' queryStatus: in_progress remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:38.855Z' useIndexJoin: false - createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... id: 3a3e85c4-96e7-486b-ae02-827120104301 outputRows: 24516 processingTime: 9212 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: completed remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:19.17Z' useIndexJoin: false schema: $ref: '#/components/schemas/GetDataQueryJobsResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List data query jobs tags: - Data Queries post: description: | Submits a [data query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query) to be executed by Zuora, creating a new query job. Use the [Retrieve a data query job](https://developer.zuora.com/v1-api-reference/api/operation/GET_DataQueryJob/) endpoint to monitor the job status and access the results once complete. **Note:** The request must include the `Content-Type: application/json` header. If this header is missing, the request will fail with the following error: `{"code":415,"message":"HTTP 415 Unsupported Media Type"}` operationId: POST_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: Content-Type in: header required: true description: | Specifies the media type of the request payload. You must include the `Content-Type: application/json` header when submitting a data query. schema: type: string enum: - application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitDataQueryRequest' required: true responses: '200': content: application/json: examples: response: value: data: id: 5948abde-b875-4d06-ad07-c2138853d8bc query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 useIndexJoin: false sourceData: LIVE queryStatus: accepted remainingRetries: 3 retries: 3 updatedOn: '2024-07-09T09:47:49.675Z' createdOn: '2024-07-09T09:47:49.675Z' createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 createdByUserEmail: amy@mycompany.com schema: $ref: '#/components/schemas/SubmitDataQueryResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: code: 400 message: Unable to process JSON schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '415': content: application/json: examples: response: value: code: 415 message: HTTP 415 Unsupported Media Type schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: | Unsupported Media Type. This error is returned when the request is missing the required `Content-Type: application/json` header. summary: Submit a data query tags: - Data Queries /query/jobs/{job-id}: delete: 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`. operationId: DELETE_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: job-id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: examples: response: value: data: createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 id: 3a3e85c4-96e7-486b-ae02-827120104301 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: cancelled remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:22:16.965Z' useIndexJoin: false schema: $ref: '#/components/schemas/DeleteDataQueryJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: examples: response: value: code: 1003 message: Query job c20a8ff4-3960-4c85-b067-d5259035f523 is not in accepted or in_progress status schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a data query job tags: - Data Queries get: 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. If you are an administrator, you can retrieve every query job in your tenant. If 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. operationId: GET_DataQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: job-id required: true schema: format: uuid maxLength: 36 minLength: 36 type: string responses: '200': content: application/json: examples: response: value: data: createdBy: 514f3ea1-6716-4f44-b6e0-9a8f0cf44bd2 dataFile: https://example.s3.us-west-2.amazonaws.com/3a3e85c4-96e7-486b-ae02-827120104301_24921638725108715.json?X-Amz-Security-Token=... id: 3a3e85c4-96e7-486b-ae02-827120104301 outputRows: 24516 processingTime: 9212 query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 queryStatus: completed remainingRetries: 3 sourceData: LIVE updatedOn: '2018-08-17T13:14:19.17Z' useIndexJoin: false schema: $ref: '#/components/schemas/GetDataQueryJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '403': content: application/json: examples: response: value: code: 1009 message: Access denied for restricted job ea50af05-6163-47e1-bf9b-c8e10648d8a3 schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '404': content: application/json: examples: response: value: code: 1001 message: 'No such query: 1e8e8586-5366-4cdf-a01d-fae3b2cf8427' schema: $ref: '#/components/schemas/DataQueryErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Retrieve a data query job tags: - Data Queries /v1/batch-query/: post: description: | Submits an AQuA job that contains an aggregated list of ZOQL and Export ZOQL queries. operationId: POST_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitBatchQueryRequest' required: true responses: '200': content: application/json: examples: response: value: id: 8ad08f06909293cd01909613f23549e4 status: submitted version: 1 format: CSV batches: - batchId: 8ad08f06909293cd01909613f23549e5 status: pending localizedStatus: pending apiVersion: '145.0' recordCount: 0 batchType: zoql full: true query: select AccountNumber, BillCycleDay from Account encrypted: none useLastCompletedJobQueries: false offset: 0 schema: $ref: '#/components/schemas/SubmitBatchQueryResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Submit an aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/partner/{partner}/project/{project}: get: 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. operationId: GET_LastBatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | The unique ID of a data integration partner. in: path name: partner required: true schema: type: string - description: | The unique ID of a data integration project for a particular partner. in: path name: project required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: batches: - apiVersion: '60.0' batchId: 402881824835bb2a01483c1e678c025b batchType: zoqlexport fileId: 402881824835bb2a01483c1e67c7025d full: false message: '' name: AccountingPeriod query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod recordCount: 0 status: completed encrypted: none format: CSV id: 402881824835bb2a01483c1e678a025a name: Example partner: salesforce project: 00170000011K3Ub sourceData: LIVE startTime: '2014-09-03 08:24:58' status: completed version: '1.1' schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Retrieve the last completed aggregate query job tags: - Aggregate Queries /v1/batch-query/jobs/{jobid}: delete: description: | Cancels the current AQuA job, only if the job is not complete. If the job is complete, an error is thrown. operationId: DELETE_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: jobid required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: batches: - batchId: e20b07474688ad5001468daf10ea01df batchType: zoqlexport fileId: e20b07474688ad5001468daf155f01f5 message: '' name: InvoiceItemAdjustment query: select AccountingCode,CancelledDate,CreatedDate,Id,InvoiceId,InvoiceItemName, InvoiceNumber,SourceType,AdjustmentNumber,ServiceStartDate,ServiceEndDate,AdjustmentDate, Amount,Status,AccountId,SourceId,Type,ReasonCode, UpdatedDate from InvoiceItemAdjustment recordCount: 1580 status: completed - batchId: e20b07474688ad5001468daf10ec01e0 batchType: zoqlexport fileId: e20b07474688ad5001468daf166601f6 message: '' name: InvoiceAdjustment query: select AccountingCode,CancelledOn,CreatedDate,Id,ImpactAmount,Invoice.Id, InvoiceNumber,AdjustmentNumber,AdjustmentDate,Amount,Status,Account.Id,Type,ReasonCode, UpdatedDate from InvoiceAdjustment recordCount: 411 status: completed encrypted: none format: CSV id: e20b07474688ad5001468daf10e501de name: June10 sourceData: LIVE status: cancelled version: '1.1' schema: $ref: '#/components/schemas/DeleteBatchQueryJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Cancel a running aggregate query job tags: - Aggregate Queries get: 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. operationId: GET_BatchQueryJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the query job. in: path name: jobid required: true schema: type: string - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Version' responses: '200': content: application/json: examples: response: value: batches: - apiVersion: '60.0' batchId: 402881824835bb2a01483c19f7da0257 batchType: zoqlexport fileId: 402881824835bb2a01483c19f8190259 full: true message: '' name: AccountingPeriod query: select Id,StartDate,EndDate,FiscalYear,Name,Status from AccountingPeriod recordCount: 1 status: completed encrypted: none format: CSV id: 402881824835bb2a01483c19f7d70256 name: Example partner: salesforce project: 00170000011K3Ub sourceData: LIVE startTime: '2014-09-03 08:20:07' status: completed version: '1.1' schema: $ref: '#/components/schemas/GetAggregateQueryJobResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' Concurrency-Limit-Type: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type' Concurrency-Limit-Limit: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit' Concurrency-Limit-Remaining: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining' summary: Retrieve an aggregate query job tags: - Aggregate Queries /deployment-manager/deployment_artifacts: get: description: | Download a template for migration in the Deployment manager from the source tenant to the target tenant. operationId: GET_DownloadDeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Id which template needs to be downloaded. in: query name: deployment_template_id required: true schema: type: string responses: '200': content: application/json: examples: response: value: {} schema: $ref: '#/components/schemas/JsonNode' description: Successfully downloaded the template. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Id is invalid headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: Download a template tags: - Configuration Templates /deployment-manager/deployment_artifacts/compare: post: description: | To Compare the configurations from the template downloaded and used in deployment manager for migration which is available in source and target tenant. operationId: POST_CompareTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Customers need to specify tenant ID. in: query name: tenant required: true schema: type: string requestBody: content: multipart/form-data: schema: properties: template: description: Template contains the config metadata and target tenant information. format: binary type: string type: object responses: '200': content: application/json: examples: response: value: customFields: - errors: [] originalPayload: count: 2 definitions: Account: schema: additionalProperties: false indexed: - Last_Token_Transaction_Date__c - idx_date_1__c properties: CollectionsAgent__c: createdDate: '2022-08-22T18:16:38.000Z' default: abc description: '' label: Collections Agent maxLength: 255 type: string updatedDate: '2022-08-22T18:16:38.000Z' InCollections__c: createdDate: '2022-08-18T12:38:04.000Z' description: '' label:
maxLength: 25 type: string updatedDate: '2022-08-18T12:38:04.000Z' Last_Token_Transaction_Date__c: createdDate: '2022-08-22T19:30:10.000Z' description: '' label: Last_Token_Transaction_Date maxLength: 255 type: string updatedDate: '2022-08-22T19:30:10.000Z' idx_date_1__c: createdDate: '2022-08-18T12:38:13.000Z' description: test format: date label: idx_date_1 type: string updatedDate: '2022-08-18T12:38:13.000Z' non_idx_text_1__c: createdDate: '2022-08-18T12:38:14.000Z' default: non_idx_text_1 description: non_idx_text_1 label: non_idx_text_1 maxLength: 50 type: string updatedDate: '2022-08-18T12:38:14.000Z' readOnlyOnUI: - idx_date_1__c - non_idx_text_1__c type: object type: Account AccountingCode: schema: additionalProperties: false properties: AccountingCodeCustomDate__c: createdDate: '2022-02-08T07:20:15.000Z' format: date label: AccountingCodeCustomDate type: string updatedDate: '2022-02-08T07:20:15.000Z' AccountingCodeCustomPickList__c: createdDate: '2022-02-08T07:20:18.000Z' default: Alpha enum: - Alpha - Beta - Omega label: AccountingCodeCustomPickList type: string updatedDate: '2022-02-08T07:20:18.000Z' AccountingCodeCustomText__c: createdDate: '2022-02-01T08:41:03.000Z' default: custom text label: AccountingCodeCustomText maxLength: 64 type: string updatedDate: '2022-02-01T08:41:03.000Z' type: object type: AccountingCode response: - componentType: CustomFields error: '-' id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a key: idx_date_1 method: GET payload: API_name: idx_date_1__c UIReadOnly: true description: test format: date indexed: true label: idx_date_1 result: DONE segregationKey: Account templateId: null url: '-' 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 customObjects: - errors: [] originalPayload: {} response: - componentType: CustomObjects error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: api_name: zzzzzzzzzz customFields: - api_name: isFilterable__c description: ' ' field_name: isFilterable filterable: 'true' required: 'false' type: boolean - api_name: picklist__c description: ' ' field_name: picklist filterable: 'false' required: 'false' type: string - api_name: zzz__c description: ' ' field_name: zzz filterable: 'false' required: 'false' type: string description: ' ' enableRecordMigration: 'false' label: zzzzzzzzzz result: DONE segregationKey: Available Custom Objects templateId: null url: /zzzzzzzzzz segregationKeys: - Available Custom Objects 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: - errors: [] originalPayload: 2c92c8fb7ddc795b017dde4350c949a0: - active: false calloutAuth: false calloutOauth2: false calloutOption: false calloutPreemptiveAuth: false calloutRetriable: false contentType: APPLICATION_JSON 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. emailOption: true emailTemplate: 2c92c8f9631ea3850163271f80152de2 emailTemplateName: Invoice Posted Default Email Template eventId: 2c92c8f9631ea3850163271f7fa02da0 eventName: New Invoice Posted hidden: false id: 2c92c8fb7ddc795b017dde437a0949a6 name: Invoice Posted within a Bill Run of Auto-Post param1: BILLRUN param4: Not include invoice PDF profileId: 2c92c8fb7ddc795b017dde4350c949a0 useCustomRequestBody: false response: - componentType: Notifications error: '-' id: f5ee9c26-8420-4f92-9463-1983d1268281 key: B2C Customers method: GET payload: description: '' id: 2c92c8fb7ddc795b017dde4350c949a0 isDefault: false locale: default name: B2C Customers result: DONE segregationKey: Communication profile templateId: null url: settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0 segregationKeys: - Communication profile - Email Templates 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: - errors: [] originalPayload: {} response: - componentType: Settings error: | {"success":false,"reasons":[{"message":"Failed to get user info","code":"90000011"}]} id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6 key: AccountingPeriods method: GET payload: {} result: FAILED segregationKey: Finance templateId: null url: v1/accounting-periods - componentType: Settings error: null id: 6a27d0d3-3c4c-408f-b160-04510014ebf1 key: AccountingRules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowRevenueScheduleNegativeAmounts: false allowUsageInClosedPeriod: false result: DONE segregationKey: Finance templateId: null url: /accounting-rules segregationKeys: - Finance - Billing - Administration - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration - ManageDataAccessControl workflows: - errors: [] originalPayload: {} response: - componentType: WorkFlows error: '-' id: df74980b-ff25-4684-a950-7e0c25810a72 key: Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13 method: GET payload: active_version: calloutTrigger: true createdAt: '2022-08-21T10:51:22.613-07:00' created_by: created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' work_email: rkumar@zuora.com definitionId: 1 description: '' id: 2483 interval: null name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Active timezone: null type: Workflow::Setup updatedAt: '2022-08-21T10:51:22.613-07:00' updated_by: created_at: N/A updated_at: N/A work_email: N/A version: 0.0.13 calloutTrigger: true createdAt: '2022-08-21T10:51:22.613-07:00' description: '' id: 1 interval: null latest_inactive_versions: - calloutTrigger: true createdAt: '2022-05-10T05:21:37.192-07:00' created_by: created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' work_email: rkumar@zuora.com definitionId: 1 description: '' id: 689 interval: null name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Inactive timezone: null type: Workflow::Setup updatedAt: '2022-05-10T05:21:37.192-07:00' updated_by: created_at: N/A updated_at: N/A work_email: N/A version: 0.0.10 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Active timezone: null updatedAt: '2022-08-21T10:51:22.613-07:00' result: DONE segregationKey: Resume Subscriptions for Accounts with Zero Balance Limit 1 templateId: null url: '1' segregationKeys: - Payment to Provision - Negative Invoices to Positive Account Credit Balance Limit 1 - Automated Dunning | 2nd Attempt Failed - Subscription Price Uplift -- JSON Transform schema: $ref: '#/components/schemas/CompareSchemaInfoResponse' description: OK headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': 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. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: Compare settings between a source tenant and a target tenant tags: - Configuration Templates /deployment-manager/deployment_artifacts/deploy: post: description: | To migrate the selected configuration of a tenant in Deployment Manager migration while using template from the compare screen. operationId: POST_MigrateTenantSettings parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Customers need to specify tenant ID in query parameter. in: query name: tenant required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/TemplateMigrationClientRequest' description: Request Details. required: true responses: '200': content: application/json: examples: response: value: 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 schema: $ref: '#/components/schemas/MigrationClientResponse' description: Successfully migrated from source to target. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': 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. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: Migrate settings from source tenant to target tenant tags: - Configuration Templates /deployment-manager/deployment_artifacts/retrieve-settings: get: description: | When the advanced option is clicked, get the details/metadata of the components, such as settings, notifications, workflow, etc. operationId: GET_SourceComponentDetails parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': content: application/json: examples: response: value: customFields: - errors: [] originalPayload: count: 2 definitions: Account: schema: additionalProperties: false indexed: - Last_Token_Transaction_Date__c - idx_date_1__c properties: CollectionsAgent__c: createdDate: '2022-08-22T18:16:38.000Z' default: abc description: '' label: Collections Agent maxLength: 255 type: string updatedDate: '2022-08-22T18:16:38.000Z' InCollections__c: createdDate: '2022-08-18T12:38:04.000Z' description: '' label:
maxLength: 25 type: string updatedDate: '2022-08-18T12:38:04.000Z' Last_Token_Transaction_Date__c: createdDate: '2022-08-22T19:30:10.000Z' description: '' label: Last_Token_Transaction_Date maxLength: 255 type: string updatedDate: '2022-08-22T19:30:10.000Z' idx_date_1__c: createdDate: '2022-08-18T12:38:13.000Z' description: test format: date label: idx_date_1 type: string updatedDate: '2022-08-18T12:38:13.000Z' non_idx_text_1__c: createdDate: '2022-08-18T12:38:14.000Z' default: non_idx_text_1 description: non_idx_text_1 label: non_idx_text_1 maxLength: 50 type: string updatedDate: '2022-08-18T12:38:14.000Z' readOnlyOnUI: - idx_date_1__c - non_idx_text_1__c type: object type: Account AccountingCode: schema: additionalProperties: false properties: AccountingCodeCustomDate__c: createdDate: '2022-02-08T07:20:15.000Z' format: date label: AccountingCodeCustomDate type: string updatedDate: '2022-02-08T07:20:15.000Z' AccountingCodeCustomPickList__c: createdDate: '2022-02-08T07:20:18.000Z' default: Alpha enum: - Alpha - Beta - Omega label: AccountingCodeCustomPickList type: string updatedDate: '2022-02-08T07:20:18.000Z' AccountingCodeCustomText__c: createdDate: '2022-02-01T08:41:03.000Z' default: custom text label: AccountingCodeCustomText maxLength: 64 type: string updatedDate: '2022-02-01T08:41:03.000Z' type: object type: AccountingCode response: - componentType: CustomFields error: '-' id: a8a0ff9f-3297-45a5-a523-4f5d5f4f393a key: idx_date_1 method: GET payload: API_name: idx_date_1__c UIReadOnly: true description: test format: date indexed: true label: idx_date_1 result: DONE segregationKey: Account templateId: null url: '-' 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 customObjects: - errors: [] originalPayload: {} response: - componentType: CustomObjects error: '-' id: 456335f2-711d-4e73-b8ec-3309e78b403a key: zzzzzzzzzz method: GET payload: api_name: zzzzzzzzzz customFields: - api_name: isFilterable__c description: ' ' field_name: isFilterable filterable: 'true' required: 'false' type: boolean - api_name: picklist__c description: ' ' field_name: picklist filterable: 'false' required: 'false' type: string - api_name: zzz__c description: ' ' field_name: zzz filterable: 'false' required: 'false' type: string description: ' ' enableRecordMigration: 'false' label: zzzzzzzzzz result: DONE segregationKey: Available Custom Objects templateId: null url: /zzzzzzzzzz segregationKeys: - Available Custom Objects 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: - errors: [] originalPayload: 2c92c8fb7ddc795b017dde4350c949a0: - active: false calloutAuth: false calloutOauth2: false calloutOption: false calloutPreemptiveAuth: false calloutRetriable: false contentType: APPLICATION_JSON 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. emailOption: true emailTemplate: 2c92c8f9631ea3850163271f80152de2 emailTemplateName: Invoice Posted Default Email Template eventId: 2c92c8f9631ea3850163271f7fa02da0 eventName: New Invoice Posted hidden: false id: 2c92c8fb7ddc795b017dde437a0949a6 name: Invoice Posted within a Bill Run of Auto-Post param1: BILLRUN param4: Not include invoice PDF profileId: 2c92c8fb7ddc795b017dde4350c949a0 useCustomRequestBody: false response: - componentType: Notifications error: '-' id: f5ee9c26-8420-4f92-9463-1983d1268281 key: B2C Customers method: GET payload: description: '' id: 2c92c8fb7ddc795b017dde4350c949a0 isDefault: false locale: default name: B2C Customers result: DONE segregationKey: Communication profile templateId: null url: settings/communication-profiles/2c92c8fb7ddc795b017dde4350c949a0 segregationKeys: - Communication profile - Email Templates 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: - errors: [] originalPayload: {} response: - componentType: Settings error: | {"success":false,"reasons":[{"message":"Failed to get user info","code":"90000011"}]} id: bfcb76d9-3fb8-4a15-8d13-fe0b805b5ee6 key: AccountingPeriods method: GET payload: {} result: FAILED segregationKey: Finance templateId: null url: v1/accounting-periods - componentType: Settings error: null id: 6a27d0d3-3c4c-408f-b160-04510014ebf1 key: AccountingRules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowRevenueScheduleNegativeAmounts: false allowUsageInClosedPeriod: false result: DONE segregationKey: Finance templateId: null url: /accounting-rules segregationKeys: - Finance - Billing - Administration - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration - ManageDataAccessControl workflows: - errors: [] originalPayload: {} response: - componentType: WorkFlows error: '-' id: df74980b-ff25-4684-a950-7e0c25810a72 key: Resume Subscriptions for Accounts with Zero Balance Limit 1_0.0.13 method: GET payload: active_version: calloutTrigger: true createdAt: '2022-08-21T10:51:22.613-07:00' created_by: created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' work_email: rkumar@zuora.com definitionId: 1 description: '' id: 2483 interval: null name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Active timezone: null type: Workflow::Setup updatedAt: '2022-08-21T10:51:22.613-07:00' updated_by: created_at: N/A updated_at: N/A work_email: N/A version: 0.0.13 calloutTrigger: true createdAt: '2022-08-21T10:51:22.613-07:00' description: '' id: 1 interval: null latest_inactive_versions: - calloutTrigger: true createdAt: '2022-05-10T05:21:37.192-07:00' created_by: created_at: '2021-11-22T19:06:54.279-08:00' updated_at: '2022-09-06T05:16:20.455-07:00' work_email: rkumar@zuora.com definitionId: 1 description: '' id: 689 interval: null name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Inactive timezone: null type: Workflow::Setup updatedAt: '2022-05-10T05:21:37.192-07:00' updated_by: created_at: N/A updated_at: N/A work_email: N/A version: 0.0.10 name: Resume Subscriptions for Accounts with Zero Balance Limit 1 ondemandTrigger: true priority: Medium scheduledTrigger: false status: Active timezone: null updatedAt: '2022-08-21T10:51:22.613-07:00' result: DONE segregationKey: Resume Subscriptions for Accounts with Zero Balance Limit 1 templateId: null url: '1' segregationKeys: - Payment to Provision - Negative Invoices to Positive Account Credit Balance Limit 1 - Automated Dunning | 2nd Attempt Failed - Subscription Price Uplift -- JSON Transform schema: $ref: '#/components/schemas/SettingSourceComponentResponse' description: Successfully retrieved the template metadata. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Id is invalid headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: List all details of source components tags: - Configuration Templates /deployment-manager/deployment_templates: get: description: | Retrieves all the templates and their details which are created already. operationId: GET_Templates parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' responses: '200': content: application/json: examples: response: value: templates: - active: true content: null createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' description: '' entityName: Global environment: US-API-Sandbox-Staging errors: '-' id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 name: Testing Tax status: DONE tenantName: Data Connect - active: true content: null createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' description: '' entityName: Global environment: US-API-Sandbox-Staging errors: '-' id: 24ba307c-cd94-4b9f-b849-c2d08f028c53 name: tempExample3975161566467657 status: DONE tenantName: Data Connect schema: $ref: '#/components/schemas/TemplateResponse' description: Successfully received all templates throught Template Response Object. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: List all templates tags: - Configuration Templates post: 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. operationId: POST_DeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Idempotency_Key' - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTemplateRequestContent' description: CreateTemplateRequestContent JSON object which contains the details to create a template. required: true responses: '200': content: application/json: examples: response: value: active: true content: null createdBy: Daco user createdOn: '2022-09-14T16:06:43.155Z' description: '' entityName: Global environment: US-API-Sandbox-Staging errors: '-' id: 210656b3-0d89-4bc6-92b9-634653e729af name: Test_Template status: Inprogress tenantName: Data Connect schema: $ref: '#/components/schemas/TemplateDetailResponse' description: Successfully created the template. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '201': 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. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad Request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: Create a deployment template tags: - Configuration Templates /deployment-manager/deployment_templates/{id}: delete: description: | Deletes a specific template by passing the ID. operationId: DELETE_DeploymentTemplate parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The ID of the template that needs to be deleted. in: path name: id required: true schema: type: string responses: '200': description: Successfully deleted the template. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '204': description: No Content headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Id is invalid headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: Delete a template tags: - Configuration Templates get: description: | Returns the detailed information of a specific template by passing its template ID. operationId: GET_DeploymentTemplateDetail parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The ID of the template that needs to be retrieved. in: path name: id required: true schema: type: string responses: '200': content: application/json: examples: response: value: active: true content: customFields: [] customObjects: [] dataAccessControl: [] notifications: [] productCatalog: [] settings: - errors: [] originalPayload: null response: - componentType: Settings error: null id: 301e73b7-420c-4770-9c37-3d966c1e2690 key: AccountingRules method: GET payload: allowBlankAccountingCodes: true allowCreationInClosedPeriod: true allowRevenueScheduleNegativeAmounts: false allowUsageInClosedPeriod: false result: DONE segregationKey: Finance templateId: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 url: /accounting-rules segregationKeys: - Administration - ManageDataAccessControl - Finance - Billing - ManageMultiEntity - Payments - Taxation - BillingDocumentConfiguration workflows: [] createdBy: Daco user createdOn: '2022-08-22T14:06:53.659Z' description: '' entityName: Global environment: US-API-Sandbox-Staging errors: '-' id: e8ed70e9-5d31-41c3-8b20-981a5b3e9972 name: Testing Tax status: DONE tenantName: Data Connect schema: $ref: '#/components/schemas/TemplateDetailResponse' description: Successfully received the template. headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' '400': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Bad request headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '401': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Unauthorized headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '403': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Forbidden headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string '404': content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' description: Not Found headers: Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: 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. schema: maxLength: 64 type: string summary: List all details of a template tags: - Configuration Templates /deployment-manager/deployment_templates/sync: post: tags: - Configuration Templates summary: Sync a deployment template with latest changes description: | Synchronizes an existing deployment template with the latest changes in the source tenant. operationId: syncDeploymentTemplate parameters: - name: Content-Type in: header required: true description: Specify the content type of the request. Use multipart/form-data. schema: type: string example: multipart/form-data - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: required: true content: multipart/form-data: schema: $ref: '#/components/schemas/SyncDeploymentTemplateRequest' responses: '200': description: Successfully synced the template. content: application/json: schema: $ref: '#/components/schemas/TemplateDetailResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ConfigTemplateErrorResponse' /deployment-manager/deployments/tenants: post: tags: - Metadata summary: Compare and deploy a source tenant to a target tenant description: | Compare and deploy a source tenant to a target tenant. operationId: CompareDeployTenant parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string requestBody: content: multipart/form-data: schema: required: - customFields - description - name - notifications - productCatalog - reporting - sendEmail - settings - sourceTenantId - userRoles - workflows type: object properties: name: type: string description: Deployment's name. description: type: string description: Deployment's description. sendEmail: type: boolean description: Specifies if an email should be sent. emails: type: string description: If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com. comments: type: string description: Content of the email to be sent. settings: type: boolean description: Specified if settings module should be considered in the deployment process. notifications: type: boolean description: Specified if notifications module should be considered in the deployment process. workflows: type: boolean description: Specified if workflows module should be considered in the deployment process. customFields: type: boolean description: Specified if customFields module should be considered in the deployment process. customObjects: type: boolean description: Specified if customObjects module should be considered in the deployment process. productCatalog: type: boolean description: Specified if productCatalog module should be considered in the deployment process. taxation: type: boolean description: Specified if taxation module should be considered in the deployment process. userRoles: type: boolean description: Specified if userRoles module should be considered in the deployment process. reporting: type: boolean description: Specified if reporting module should be considered in the deployment process. sourceTenantId: type: string description: Id of the source tenant. required: true responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' example: id: 8039d54b-da6f-4d80-88d5-06220c42861f status: DEPLOYING '400': description: Validation of dependent module error. content: application/json: example: errorCode: BAD_REQUEST errorMessage: Dependent module customFields is not included /deployment-manager/deployments/templates: post: tags: - Metadata summary: Compare and deploy a template to a tenant description: | Compare and deploy a template to a tenant. operationId: CompareDeployTemplate parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string requestBody: content: multipart/form-data: schema: required: - description - name - sendEmail - template type: object properties: name: type: string description: Deployment's name description: type: string description: Deployment's description. sendEmail: type: boolean description: Specifies if an email should be sent. emails: type: string description: If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com. comments: type: string description: Content of the email to be sent. template: type: string description: Template file. format: binary required: true responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' example: id: 8039d54b-da6f-4d80-88d5-06220c42861f status: DEPLOYING /deployment-manager/deployments/{migrationId}/revert: post: tags: - Metadata summary: Revert a deployment description: | Revert a deployment. operationId: RevertDeployment parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string - name: migrationId in: path description: | The unique ID of a migration. required: true schema: type: string responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window 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: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window 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: type: number Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Policies/Concurrent_Request_Limits#Rate_limits) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string content: application/json: schema: type: object properties: id: type: string description: ID of the Deployment Manager migration process. name: type: string description: Name of the Deployment Manager migration process. description: type: string description: Description of the Deployment Manager migration process. sourceTenantName: type: string description: Name of the source Tenant. sourceTenantDescription: type: string description: Description of the source Tenant. status: type: string description: Status of the Deployment Manager migration process. enum: - DEPLOYING - REVERTING - PARTIALLY-REVERTED - FAILED - ROLLBACK-FAILED - REVERTED - COMPARING - SUBMITTED - SKIPPED - IDENTICAL - COMPARE-DONE - COMPARE-FAILED - CANCELLED startTime: type: string description: start timestamp of the Deployment Manager migration process. endTime: type: string description: end timestamp of the Deployment Manager migration process. migratedBy: type: string description: User who initiated the Deployment Manager migration process. type: type: string description: Type of the Deployment Manager migration process. environment: type: string description: Environment of the Deployment Manager migration process. emailIds: type: string description: emailIds notified of the Deployment Manager migration process. productCatalog: type: boolean description: Boolean flag specifies if the migration process includes product catalog module. errors: type: string description: Errors of the Deployment Manager migration process. example: id: 2122b60e-49ca-4b16-ae1c-f7f315ff0010 name: Migrate - Custom objects description: Migrate - Custom objects sourceTenantName: Test Sandbox sourceTenantDescription: Sample Source Tenant status: REVERTING startTime: '2023-08-30 04:35:19.080000+00:00' endTime: '2023-08-29 15:49:41.986000+00:00' migratedBy: Admin type: Tenant environment: US-API-Sandbox emailIds: admin@zuora.com productCatalog: false errors: '-' /deployment-manager/deployments/{migrationId}: get: tags: - Metadata summary: Retrieve a deployment log description: | Retrieve a deployment log. operationId: FetchDeploymentLogs parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string - name: migrationId in: path description: | The unique ID of a migration. required: true schema: type: string responses: '200': description: OK content: application/json: schema: type: object properties: id: type: string description: ID of the migration process. name: type: string description: Name of the migration. description: type: string description: Description of the migration. status: type: string description: Migration status. targetTenant: type: object properties: id: type: string description: Target tenant id. name: type: string description: Target tenant name. environment: type: string description: Target tenant description. deploymentDate: type: string description: Deployment timestamp. runBy: type: string description: Name of the user who executed the migration. succeeded: type: array items: type: object properties: component: type: string description: Component name. subComponent: type: string description: Subcomponent name. key: type: string description: Key to identify a particular migration data. failed: type: array items: type: object properties: component: type: string description: Component name. subComponent: type: string description: Subcomponent name. key: type: string description: Key to identify a particular migration data. errorInfo: type: string description: Error details of the migration. skipped: type: array items: type: object properties: component: type: string description: Component name. subComponent: type: string description: Subcomponent name. key: type: string description: Key to identify a particular migration data. reason: type: string description: The rationale behind the non-migration of specific data. example: id: 8039d54b-da6f-4d80-88d5-06220c42861f name: Deploy - Product catalog description: Deploy - Product catalog status: PARTIALLY-DONE targetTenant: id: '9958' name: Test API sandbox environment: US-API-Sandbox-Staging deploymentDate: '2023-08-28 11:34:18.682000+00:00' runBy: Admin succeeded: - component: Settings subComponent: Billing key: Currency failed: - component: Settings subComponent: Finance key: AllRevenueRecognitionModels errorInfo: 'Error while updating the payload with path : /revenue-recognition-models --> You do not have permission to perform this operation.' - component: Settings subComponent: Finance key: AccountingRules errorInfo: 'Error while updating the payload with path : /accounting-rules --> You do not have Currency Conversion permission. You can request permission from your administrator.' - component: Settings subComponent: Billing key: SubscriptionSettings errorInfo: |- { "errorCode" : "REMOTE_HTTP_CLIENT_ERROR", "remoteHttpStatus" : 403, "messages" : [ "{\"error\":\"403 Forbidden\",\"processId\":\"A5EF7EA92B3B95B0\",\"message\":\"security.error.noPermission\"}" ] } skipped: - component: Settings subComponent: Billing key: NumberAndSku reason: RETRY-ABLE ERROR - component: Settings subComponent: Administration key: AuditTrailSettings reason: RETRY-ABLE ERROR /deployment-manager/deployments/tenant/product_catalog: post: tags: - Metadata summary: Compare and deploy the product catalog of a tenant to a target tenant description: | Compare and deploy the product catalog of a tenant to a target tenant. operationId: CompareDeployTenantProductCatalog parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string requestBody: content: multipart/form-data: schema: required: - activeProducts - activeRatePlans - compareField - description - inActiveProducts - inActiveRatePlans - name - sendEmail - sourceTenantId type: object properties: name: type: string description: Deployment's name. example: Tenant01PC description: type: string description: Deployment's description. example: Product Catalog tenant - 01 sendEmail: type: boolean description: Specifies if an email should be sent. example: true emails: type: string description: If sendEmail parameter is set to true, comma separated values of emails can be specified. Example email1@test.com,email2@test.com. example: zuoraUser@zuora.com comments: type: string description: Content of the email to be sent. example: Product Catalog tenant - 47 inActiveProducts: type: boolean description: Specifies if inactive products needs to be migrated. example: false activeProducts: type: boolean description: Specifies if active products needs to be migrated. example: true activeRatePlans: type: boolean description: Specifies if active rate plans needs to be migrated. example: true inActiveRatePlans: type: boolean description: Specifies if inactive active rate plans needs to be migrated. example: true compareField: type: string description: Specifies the compare field to be using during migration. enum: - name - sku example: name sourceTenantId: type: string description: Specifies the source tenant id. example: 83e7e56d-0e02-4b4d-91f6-cc77f322c40b required: true responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' example: id: 8039d54b-da6f-4d80-88d5-06220c42861f status: DEPLOYING '400': description: Validation of dependent module error content: application/json: example: errorCode: BAD_REQUEST errorMessage: Dependent module customFields is not included /deployment-manager/deployments/template/product_catalog: post: tags: - Metadata summary: Compare and deploy a template for product catalog to a tenant description: | Compare and deploy a template for product catalog to a tenant. operationId: CompareDeployTemplateProductCatalog parameters: - name: Zuora-Entity-Ids in: header 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. schema: type: string requestBody: content: multipart/form-data: schema: required: - activeProducts - activeRatePlans - compareField - description - inActiveProducts - inActiveRatePlans - name - sendEmail - template type: object properties: name: type: string description: Deployment's name. example: Deploy PC description: type: string description: Deployment's description. example: Import Product Catalog - template sendEmail: type: boolean description: Specifies if an email should be sent. example: true emails: type: string description: If sendEmail parameter is set to true, comma separated values of emails can be specified. example: zuoraUser1@zuora.com,zuoraUser2@zuora.com comments: type: string description: Content of the email to be sent. example: Import Product Catalog - template template: type: string description: Template file. format: binary example: '@/Users/praghav/Downloads/products.json' inActiveProducts: type: boolean description: Specifies if inactive products needs to be migrated. example: false activeProducts: type: boolean description: Specifies if active products needs to be migrated. example: true activeRatePlans: type: boolean description: Specifies if active rate plans needs to be migrated. example: true inActiveRatePlans: type: boolean description: Specifies if inactive rate plans needs to be migrated. example: true compareField: type: string description: Specifies the compare field to be using during migration. enum: - name - sku example: name required: true responses: '200': description: OK headers: RateLimit-Remaining: description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: | The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Content-Encoding: 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` schema: type: string RateLimit-Limit: description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string Zuora-Request-Id: description: | The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: description: | A custom identifier for tracing the API 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: maxLength: 64 type: string content: application/json: schema: $ref: '#/components/schemas/DeploymentManagerResponse' example: id: 8039d54b-da6f-4d80-88d5-06220c42861f status: DEPLOYING /bulk-data/bulk-jobs: post: description: | Creates a new bulk job. The job type can be one of Import, Delete, Update, or Cancel. The response includes the job ID and information needed to upload your data file to S3. ### Next Step: Upload the File to S3 After creating a bulk job, you must upload the data file to Amazon S3 using the information returned in the `uploadFileInfo` object. This includes: - `uploadUrl`: The S3 endpoint to which the file must be uploaded. - `formFields`: Key-value pairs to include in a multipart/form-data POST request. - `jobId`: The ID of the job, used for later submission. You can use the following cURL command to upload the file: ``` curl --request POST \ --url '' \ --header 'Content-Type: multipart/form-data' \ --form 'key=' \ --form 'bucket=' \ --form 'x-amz-algorithm=' \ --form 'x-amz-credential=' \ --form 'x-amz-date=' \ --form 'Policy=' \ --form 'x-amz-signature=' \ --form 'x-amz-security-token=' \ --form 'file=@/path/to/your/file.csv' ``` **Note**: Always use the exact form field keys returned in the `formFields` object of the API response. This is a presigned Amazon S3 POST operation and not a Zuora endpoint. After uploading the file, you must call the "Submit a bulk job for processing" operation endpoint to start processing the job. operationId: createBulkJob summary: Create a bulk job tags: - Bulk Data parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkJobRequest' responses: '200': description: Job creation successful content: application/json: schema: $ref: '#/components/schemas/CreateResponse' headers: Content-Encoding: description: This header is returned if you specify the `Accept-Encoding` request header and the response contains over 1000 bytes of data. schema: type: string RateLimit-Limit: description: The request limit quota for the time window closest to exhaustion. schema: type: string RateLimit-Remaining: description: The number of requests remaining in the time window closest to quota exhaustion. schema: type: number RateLimit-Reset: description: The number of seconds until the quota resets for the time window closest to quota exhaustion. schema: type: number Zuora-Request-Id: description: The Zuora internal identifier of the API call. schema: type: string minLength: 36 maxLength: 36 Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /bulk-data/bulk-jobs/{id}/submissions: post: operationId: submitBulkJob summary: Submit a bulk job description: | Submits a previously created bulk job for processing. This endpoint must be called **after** the file has been successfully uploaded to the S3 URL using the `uploadFileInfo` details from the create job response. If the job has not been uploaded properly before calling this endpoint, submission will fail. tags: - Bulk Data parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Bulk Job ID. in: path name: id required: true schema: type: string responses: '200': description: Job successfully submitted content: application/json: schema: $ref: '#/components/schemas/SubmitBulkJobResponse' headers: Content-Encoding: 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 schema: type: string RateLimit-Limit: description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: The Zuora internal identifier of the API call. You cannot control the value of this header. schema: type: string maxLength: 36 minLength: 36 Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' /bulk-data/bulk-jobs/{id}/summary: get: description: | Get the summary of a specific job by its ID. This operation returns a summary of the specified bulk job. operationId: getBulkJobSummary parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The unique identifier of the job whose summary is being queried. in: path name: id required: true schema: type: string format: uuid maxLength: 64 minLength: 64 responses: '200': description: Job summary retrieved successfully content: application/json: examples: response: value: id: 3a3e85c4-96e7-486b-ae02-827120104301 name: Sample Bulk Job description: Job processing sample data createdAt: 1614081280 createdBy: admin status: In Progress rowCount: 1000 rowsSucceeded: 800 rowsFailed: 200 lastUpdatedAt: 1614082580 failureReason: Processing error objectType: account jobType: Import isCustomObject: false customObjectNamespace: default dataSourceType: UserUpload systemType: BILLING fileType: csv schema: $ref: '#/components/schemas/QueryJobSummaryResponse' '404': description: Job not found '500': description: Internal server error summary: Retrieve the summary of a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/cancellations: post: description: | Cancels an existing bulk job. Once a job is cancelled, no further processing can be done, and its status will be marked as `Cancelled`. **Note**: Cancellation of a job is only allowed before it reaches the `In Progress` status. Once a job is in progress, it cannot be cancelled but only be aborted. operationId: cancelBulkJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Internal identifier of the job to cancel. in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: examples: response: value: id: 3a3e85c4-96e7-486b-ae02-827120104301 status: Cancelled schema: $ref: '#/components/schemas/IdStatusResponse' description: OK headers: Content-Encoding: description: 'This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.' schema: type: string RateLimit-Limit: description: The request limit quota for the time window closest to exhaustion. schema: type: string RateLimit-Remaining: description: The number of requests remaining in the time window closest to quota exhaustion. schema: type: number RateLimit-Reset: description: The number of seconds until the quota resets for the time window closest to quota exhaustion. schema: type: number Zuora-Request-Id: description: The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Cancel a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/aborts: post: description: | Aborts an existing job by sending a POST request to this URI. The request URI identifies the job to abort. When a job is aborted, no more records are processed. operationId: deleteAbortJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: | Internal identifier of the job to abort. in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: examples: response: value: id: 3a3e85c4-96e7-486b-ae02-827120104301 status: Aborted schema: $ref: '#/components/schemas/IdStatusResponse' description: OK headers: Content-Encoding: 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 schema: type: string RateLimit-Limit: description: The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: string RateLimit-Remaining: description: The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number RateLimit-Reset: description: The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. schema: type: number Zuora-Request-Id: description: The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: Abort a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/{id}/downloads: get: description: | Retrieves the download links for the files associated with a completed job. These files include success rows, error rows, and logs. operationId: getDownloadLinksForJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: The unique identifier of the job whose download links are being queried. in: path name: id required: true schema: type: string format: uuid maxLength: 64 minLength: 64 responses: '200': description: Get download links for a bulk job content: application/json: examples: response: value: jobId: 3a3e85c4-96e7-486b-ae02-827120104301 status: Completed sourceFile: https://example.com/source-file errorRowsFile: https://example.com/error-rows-file successRowsFile: https://example.com/success-rows-file delimiter: ',' schema: $ref: '#/components/schemas/DownloadsResponse' '404': description: Job not found or not completed '500': description: Internal server error summary: List download links for a bulk job tags: - Bulk Data /bulk-data/bulk-jobs/summaries: get: description: | Lists summaries for bulk jobs. You can filter the results using query parameters. operationId: getBulkJobSummaries parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - name: limit in: query description: Maximum number of job summaries to retrieve. required: false schema: type: integer format: int32 - name: cursor in: query description: Cursor for pagination to get the next page of results. required: false schema: type: string - name: status in: query description: Filter job summaries by job status. required: false schema: type: string enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading responses: '200': description: Job summaries retrieved successfully content: application/json: examples: response: value: data: - id: 3a3e85c4-96e7-486b-ae02-827120104301 name: Bulk Job 1 status: Completed rowCount: 500 rowsSucceeded: 480 rowsFailed: 20 createdAt: 1618327278 lastUpdatedAt: 1618327279 nextPageCursor: abc123 schema: $ref: '#/components/schemas/GetSummariesResponse' '404': description: No job summaries found '500': description: Internal server error summary: List job summaries for bulk jobs tags: - Bulk Data /bulk-data/bulk-jobs/{id}/mappings: get: description: | Retrieves the mappings for an existing bulk job. The mappings define how columns in the source file correspond to fields in the object type template. operationId: getMappingsForJob parameters: - $ref: '#/components/parameters/GLOBAL_HEADER_Accept_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Content_Encoding' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Entity_Ids_Single' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Org_Ids' - $ref: '#/components/parameters/GLOBAL_HEADER_Zuora_Track_Id' - description: Internal identifier of the job whose mappings are to be retrieved. in: path name: id required: true schema: format: uuid maxLength: 64 minLength: 64 type: string responses: '200': content: application/json: examples: response: value: mappings: - field: name column: column1 - field: description column: column2 schema: type: object properties: mappings: type: array items: type: object properties: field: type: string column: type: string description: OK headers: Content-Encoding: description: 'This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.' schema: type: string RateLimit-Limit: description: The request limit quota for the time window closest to exhaustion. schema: type: string RateLimit-Remaining: description: The number of requests remaining in the time window closest to quota exhaustion. schema: type: number RateLimit-Reset: description: The number of seconds until the quota resets for the time window closest to quota exhaustion. schema: type: number Zuora-Request-Id: description: The Zuora internal identifier of the API call. You cannot control the value of this header. schema: maxLength: 36 minLength: 36 type: string Zuora-Track-Id: $ref: '#/components/headers/GLOBAL_HEADER_RESPONSE_Zuora_TrackId' summary: List mappings for a bulk job tags: - Bulk Data components: securitySchemes: bearerAuth: type: http scheme: bearer description: | Use `Bearer {{token}}` in the `Authorization` header for authentication. basicAuth: type: http scheme: basic description: | The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Configurable Payment Retry. parameters: GLOBAL_HEADER_Zuora_Track_Id: name: Zuora-Track-Id in: header required: false 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 (`'`). schema: type: string maxLength: 64 GLOBAL_HEADER_Idempotency_Key: name: Idempotency-Key in: header required: false 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. 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. schema: type: string maxLength: 255 GLOBAL_HEADER_Accept_Encoding: name: Accept-Encoding in: header required: false description: | Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. If 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. schema: type: string GLOBAL_HEADER_Content_Encoding: name: Content-Encoding in: header required: false 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. schema: type: string GLOBAL_REQUEST_rejectUnknownFields: name: rejectUnknownFields in: query required: 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. schema: type: boolean default: false GLOBAL_HEADER_Zuora_Entity_Ids_Single: name: Zuora-Entity-Ids in: header required: false 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 should not set this header. schema: type: string GLOBAL_HEADER_Zuora_Org_Ids: name: Zuora-Org-Ids in: header required: false description: | Comma separated IDs. If you have Zuora Multi-Org enabled, you 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. The 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs. schema: type: string GLOBAL_HEADER_X_Zuora_WSDL_Version: name: X-Zuora-WSDL-Version in: header required: false description: | Zuora WSDL version number. schema: type: string default: 79 GLOBAL_HEADER_Zuora_Version: description: | The minor API version. For a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/). in: header name: Zuora-Version required: false schema: type: string GLOBAL_REQUEST_page: name: page in: query required: false 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. schema: type: integer minimum: 1 default: 1 GLOBAL_REQUEST_pageSize: name: pageSize in: query required: false description: | The number of records returned per page in the response. schema: type: integer maximum: 40 default: 20 GLOBAL_REQUEST_pageSize_finance_accounting: name: pageSize in: query required: false description: | The number of records returned per page in the response. schema: type: integer maximum: 300 default: 300 GLOBAL_REQUEST_pageSize_finance_revenue: name: pageSize in: query required: false description: | The number of records returned per page in the response. schema: type: integer maximum: 300 default: 8 GLOBAL_HEADER_If_Match: name: If-Match in: header required: false 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. schema: type: string schemas: tokenResponse: properties: access_token: description: The generated token. type: string expires_in: description: The number of seconds until the token expires. type: number jti: description: A globally unique identifier for the token. type: string scope: description: A space-delimited list of scopes that the token can be used to access. type: string token_type: description: The type of token that was generated, i.e., `bearer`. type: string type: object ProxyCreateProduct: allOf: - properties: AllowFeatureChanges: description: | Controls whether to allow your users to add or remove features while creating or amending a subscription. **Values**: true, false (default) type: boolean Category: description: | Category of the product. Used by Zuora Quotes Guided Product Selector. **Values**: - Base Products - Add On Services - Miscellaneous Products maxLength: 100 type: string Description: description: | A description of the product. maxLength: 500 type: string EffectiveEndDate: description: | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. format: date type: string EffectiveStartDate: description: | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. format: date type: string Name: description: | The name of the product. This information is displayed in the product catalog pages in the web-based UI. maxLength: 100 type: string ProductNumber: description: | The natural key of the product. **Values**: - leave null for automatically generated string - an alphanumeric string of 100 characters or fewer **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. maxLength: 100 type: string SKU: description: | The unique SKU for the product. **Values**: - leave null for automatically generated string - an alphanumeric string of 50 characters or fewer maxLength: 50 type: string required: - EffectiveEndDate - EffectiveStartDate - Name type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' example: Name: SmartLearn Tablet EffectiveStartDate: '2024-01-01' EffectiveEndDate: '2034-01-01' ProxyCreateOrModifyResponse: properties: Id: description: '' type: string Success: description: '' type: boolean type: object ProxyBadRequestResponse: properties: Errors: items: properties: Code: description: '' type: string Message: description: '' type: string type: object type: array Success: description: '' type: boolean type: object ProxyUnauthorizedResponse: properties: message: description: | Error message. If the error message is "Authentication error", ensure that the `Authorization` request header contains valid authentication credentials, then retry the request. See [Authentication](https://developer.zuora.com/docs/guides/authentication/) for more information. If the error message is "Failed to get user info", retry the request. type: string type: object ProductObjectNSFields: description: | Container for Product fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the product's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string ItemType__NS: description: | Type of item that is created in NetSuite for the product. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). enum: - Inventory - Non Inventory - Service type: string SyncDate__NS: description: | Date when the product was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: productFieldsNS type: object ProductObjectCustomFields: additionalProperties: description: | Custom fields of the Product object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Product object. title: productFieldsCustom type: object ProxyGetProduct: allOf: - properties: AllowFeatureChanges: description: | Controls whether to allow your users to add or remove features while creating or amending a subscription. **Values**: true, false (default) type: boolean Category: description: | Category of the product. Used by Zuora Quotes Guided Product Selector. **Values**: - Base Products - Add On Services - Miscellaneous Products maxLength: 100 type: string CreatedById: description: | The automatically generated ID of the Zuora user who created the `Product` object. maxLength: 32 type: string CreatedDate: description: | The date when the `Product` object was created. format: date-time type: string Description: description: | A description of the product. maxLength: 500 type: string EffectiveEndDate: description: | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. format: date type: string EffectiveStartDate: description: | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. format: date type: string Id: description: Object identifier. type: string Name: description: | The name of the product. This information is displayed in the product catalog pages in the web-based UI. maxLength: 100 type: string SKU: description: | The unique SKU for the product. maxLength: 50 type: string UpdatedById: description: | The ID of the last user to update the object. maxLength: 32 type: string UpdatedDate: description: | The date when the object was last updated. format: date-time type: string type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' ProxyNoDataResponse: properties: done: description: '' type: boolean records: description: '' items: type: object type: array size: description: '' type: integer type: object ProxyModifyProduct: allOf: - properties: AllowFeatureChanges: description: | Controls whether to allow your users to add or remove features while creating or amending a subscription. **Values**: true, false (default) type: boolean Category: description: | Category of the product. Used by Zuora Quotes Guided Product Selector. **Values**: - Base Products - Add On Services - Miscellaneous Products maxLength: 100 type: string Description: description: | A description of the product. maxLength: 500 type: string EffectiveEndDate: description: | The date when the product expires and can't be subscribed to anymore, in `yyyy-mm-dd` format. format: date type: string EffectiveStartDate: description: | The date when the product becomes available and can be subscribed to, in `yyyy-mm-dd` format. format: date type: string Name: description: | The name of the product. This information is displayed in the product catalog pages in the web-based UI. maxLength: 100 type: string ProductNumber: description: | The natural key of the product. For existing Product objects that are created before this field is introduced, this field will be null. Use this field to specify a value for only these objects. Zuora also provides a tool to help you automatically backfill this field with tenant ID for your existing product catalog. If you want to use this backfill tool, contact [Zuora Global Support](https://support.zuora.com/). **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `133` or later. maxLength: 100 type: string SKU: description: | The unique SKU for the product. maxLength: 50 type: string type: object - $ref: '#/components/schemas/ProductObjectNSFields' - $ref: '#/components/schemas/ProductObjectCustomFields' example: Description: Portable tablet designed for kids' learning with pre-installed educational apps and games. ProxyDeleteResponse: properties: id: description: '' type: string success: description: '' type: boolean type: object POSTAccountType: allOf: - properties: accountNumber: description: | A unique account number, up to 50 characters that do not begin with the default account number prefix. If no account number is specified, one is generated. type: string additionalEmailAddresses: description: | A list of additional email addresses to receive email notifications. Use commas to separate email addresses. items: type: string type: array applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | Whether to automatically apply credit memos or unapplied payments, or both to an invoice. If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Applies a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. Prerequisite: `invoice` must be `true`. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean autoPay: description: | Whether future payments are to be automatically billed when they are due. - If this field is set to `true`, you must specify either the `creditCard` field or the `hpmCreditCardPaymentMethodId` field, but not both. - If this field is set to `false`, you can specify neither the `creditCard` field nor the `hpmCreditCardPaymentMethodId` field. type: boolean batch: description: | The alias name given to a batch. A string of 50 characters or less. **Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package. type: string billCycleDay: description: | The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (1-31, where 31 = end-of-month), or 0 for auto-set. Required if no subscription will be created. Optional if a subscription is created and defaults to the day-of-the-month of the subscription's `contractEffectiveDate`. format: int64 type: integer billToContact: $ref: '#/components/schemas/POSTAccountTypeBillToContact' collect: default: true description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean communicationProfileId: description: | The ID of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile. If none is provided, the default communication profile will be used for this account. type: string creditCard: $ref: '#/components/schemas/POSTAccountTypeCreditCard' creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string creditMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. type: string crmId: description: | CRM account ID for the account, up to 100 characters. type: string currency: description: | A currency as defined in Billing Settings in the Zuora UI. For payment method authorization, if the `paymentMethod` > `currencyCode` field is specified, `currencyCode` is used. Otherwise, this `currency` field is used for payment method authorization. If no currency is specified for the account, the default currency of the account is then used. type: string customerServiceRepName: description: | Name of the account's customer service representative, if applicable. maxLength: 50 type: string debitMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string einvoiceProfile: $ref: '#/components/schemas/PostAccountEInvoiceProfile' gatewayRoutingEligible: default: false description: | Indicates whether to include the applicable billing accounts to gateway routing for controlled adoption. type: boolean hpmCreditCardPaymentMethodId: description: | The ID of the payment method associated with this account. You can use this field to set the default payment method for the account. The payment method ID specified in this field will be set as the default payment method for this account. You can pass the ID of any valid payment method, including a system-generated payment method ID, into this field. If the `autoPay` field is set to `true`, you must provide the credit card payment method ID for either this field or the `creditCard` field, but not both. For the Credit Card Reference Transaction payment method, you can specify the payment method ID in this field or use the `paymentMethod` field to create a CC Reference Transaction payment method for an account. type: string invoiceDeliveryPrefsEmail: default: false description: | Whether the customer wants to receive invoices through email. type: boolean invoiceDeliveryPrefsPrint: default: false description: | Whether the customer wants to receive printed invoices, such as through postal mail. type: boolean invoiceTemplateId: description: | Invoice template ID, configured in Billing Settings in the Zuora UI. type: string name: description: | Account name, up to 255 characters. type: string notes: description: A string of up to 65,535 characters. type: string organizationLabel: description: | Name of the organization that the account belongs to. This field is only required when you have already turned on Multi-Org feature. type: string parentId: description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled. type: string partnerAccount: default: false description: | Whether the customer account is a partner, distributor, or reseller. You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments. **Note**: This field is available only if you have the Reseller Account feature enabled. type: boolean paymentGateway: description: | The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. type: string paymentMethod: $ref: '#/components/schemas/POSTPaymentMethodRequest' paymentTerm: description: | Payment terms for this account. Possible values are: `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`. **Note**: If you want to specify a payment term when creating a new account, you must set a value in this field. If you do not set a value in this field, Zuora will use the default value set in **Billing Settings** > **Payment Terms** from Zuora UI. type: string profileNumber: description: | The number of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile. If none is provided, the default communication profile will be used for this account. type: string purchaseOrderNumber: description: The purchase order number provided by your customer for services, products, or both purchased. type: string runBilling: default: true description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos/Rules_for_generating_invoices_and_credit_memos). The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean salesRep: description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. type: string sequenceSetId: description: | The ID or number of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set. type: string nullable: true shipToContact: $ref: '#/components/schemas/CreateAccountShipToContact' shipToSameAsBillTo: description: | Whether the ship-to contact and bill-to contact are the same entity. The created account has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body: - This field is set to `true`. - A bill-to contact is specified. - No ship-to contact is specified. type: boolean soldToContact: $ref: '#/components/schemas/POSTAccountTypeSoldToContact' soldToSameAsBillTo: description: | Whether the sold-to contact and bill-to contact are the same entity. The created account has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body: - This field is set to `true`. - A bill-to contact is specified. - No sold-to contact is specified. type: boolean subscription: $ref: '#/components/schemas/POSTAccountTypeSubscription' summaryStatementTemplateId: description: | The summary statement template ID or number. When a user attempts to generate a summary statement from the "Account Summary Statement" screen, the system utilizes this template to produce the PDF. type: string tagging: description: '' type: string targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). **Note:** The credit memo is only available only if you have the Invoice Settlement feature enabled. format: date type: string taxInfo: description: | Container for tax exempt information, used to establish the tax exempt status of a customer account. properties: VATId: description: | EU Value Added Tax ID. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). type: string companyCode: description: | Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). type: string exemptCertificateId: description: | ID of the customer tax exemption certificate. Requires Zuora Tax. type: string exemptCertificateType: description: | Type of tax exemption certificate that the customer holds. Requires Zuora Tax. type: string exemptDescription: description: | Description of the tax exemption certificate that the customer holds. Requires Zuora Tax. type: string exemptEffectiveDate: description: | Date when the customer tax exemption starts. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date. format: date type: string exemptEntityUseCode: description: | A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. maxLength: 64 type: string exemptExpirationDate: description: | Date when the customer tax exemption expires. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date. format: date type: string exemptIssuingJurisdiction: description: | Jurisdiction in which the customer tax exemption certificate was issued. type: string exemptStatus: description: | Status of the account tax exemption. Requires Zuora Tax. Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used. Values: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input. type: string type: object required: - name - currency - billToContact type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' example: name: Amy Lawrence billToContact: firstName: Amy lastName: Lawrence country: United States state: CA autoPay: false currency: USD billCycleDay: 1 POSTAccountResponseType: properties: accountId: description: | Auto-generated account ID. type: string accountNumber: description: | Account number. type: string billToContactId: description: | The ID of the bill-to contact. type: string contractedMrr: description: | Contracted monthly recurring revenue of the subscription. format: decimal type: string creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: string invoiceId: description: | ID of the invoice generated at account creation, if applicable. type: string paidAmount: description: | Amount collected on the invoice generated at account creation, if applicable. format: decimal type: string paymentId: description: | ID of the payment collected on the invoice generated at account creation, if applicable. type: string paymentMethodId: description: | ID of the payment method that was set up at account creation, which automatically becomes the default payment method for this account. type: string shipToContactId: description: | The ID of the ship-to contact. type: string soldToContactId: description: | The ID of the sold-to contact. type: string subscriptionId: description: | ID of the subscription that was set up at account creation, if applicable. type: string subscriptionNumber: description: | Number of the subscription that was set up at account creation, if applicable. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean totalContractedValue: description: | Total contracted value of the subscription. format: decimal type: string type: object ErrorResponse: example: reasons: - code: ObjectNotFound message: Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist properties: reasons: items: properties: code: description: | The error code of response. type: string message: description: The detail information of the error response type: string type: object type: array type: object CommonResponse: properties: processId: description: | The ID of the process that handles the operation. type: string reasons: description: | The container of the error code and message. This field is available only if the `success` field is `false`. items: properties: code: description: | The error code of response. type: string message: description: | The detail information of the error response type: string type: object type: array requestId: description: | Unique identifier of the request. format: uuid maxLength: 36 minLength: 36 type: string success: description: | Indicates whether the call succeeded. type: boolean type: object POSTAccountTypeBillToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for bill-to contact information for this account. If you do not provide a sold-to contact, the bill-to contact is copied to sold-to contact. Once the sold-to contact is created, changes to billToContact will not affect soldToContact and vice versa. title: Contact POSTAccountTypeCreditCard: allOf: - properties: cardHolderInfo: description: | Container for cardholder information. properties: addressLine1: description: | First address line, 255 characters or less. type: string addressLine2: description: | Second address line, 255 characters or less. type: string cardHolderName: description: | The card holder's full name as it appears on the card, e.g., "John J Smith", 50 characters or less. type: string city: description: | City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | Country; must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string email: description: | Card holder's email address, 80 characters or less. type: string phone: description: | Phone number, 40 characters or less. type: string state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string zipCode: description: | Zip code, 20 characters or less. type: string required: - addressLine1 - cardHolderName - city - country - state - zipCode cardNumber: description: | Card number, up to 16 characters. Once created, this field can't be updated or queried, and is only available in masked format (e.g., XXXX-XXXX-XXXX-1234). type: string cardType: description: | The type of the credit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways). type: string expirationMonth: description: | Two-digit expiration month (01-12). type: string expirationYear: description: | Four-digit expiration year. type: string securityCode: description: | The CVV or CVV2 security code of the card. To ensure PCI compliance, this value is not stored and cannot be queried. type: string required: - cardHolderInfo - cardNumber - cardType - expirationMonth - expirationYear type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' description: | **Note:** This field has been deprecated, and is currently available only for backward compatibility. Use the `paymentMethod` field instead to create a payment method associated with this account. Container for information on a credit card to associate with this account. If the `autoPay` field is set to `true`, you must provide one of the `paymentMethod`, `creditCard`, or `hpmCreditCardPaymentMethodId` field, but not multiple. title: creditCard PostAccountEInvoiceProfile: allOf: - properties: businessCategory: description: | The high-level category of the business. type: string enum: - B2B - B2C - B2G businessName: description: | The full official name that the Buyer is registered with the relevant legal authority. maxLength: 255 type: string businessNumber: description: | The unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India. type: string businessNumberSchemeId: description: | The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person. type: string enabled: description: | Whether to enable the e-invoicing profile for the customer account. If the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format: - The account must be configured to generate e-invoice files for billing documents. - The billing document must be in Posted status. - A business region must be created for the billing country contact, and be linked to an e-invoicing service provider. type: boolean endpointId: description: | The Buyer's electronic address, to which the application-level response to the billing document might be delivered. type: string endpointSchemeId: description: | The identification scheme identifier of the Buyer’s electronic address. type: string taxRegisterNumber: description: | The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status. type: string type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' description: | Container for e-invoicing profile information for this account. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. title: einvoiceProfile POSTPaymentMethodRequest: type: object discriminator: propertyName: type mapping: CreditCard: '#/components/schemas/CreatePaymentMethodCreditCard' CreditCardReferenceTransaction: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction' ACH: '#/components/schemas/CreatePaymentMethodACH' SEPA: '#/components/schemas/CreatePaymentMethodSEPA' Betalingsservice: '#/components/schemas/CreatePaymentMethodBetalingsservice' Autogiro: '#/components/schemas/CreatePaymentMethodAutogiro' Bacs: '#/components/schemas/CreatePaymentMethodBacs' Becs: '#/components/schemas/CreatePaymentMethodBecs' Becsnz: '#/components/schemas/CreatePaymentMethodBecsnz' PAD: '#/components/schemas/CreatePaymentMethodPAD' PayPalCP: '#/components/schemas/CreatePMPayPalCP' PayPalEC: '#/components/schemas/CreatePMPayPalEC' PayPalNativeEC: '#/components/schemas/CreatePMPayPalNativeEC' PayPalAdaptive: '#/components/schemas/CreatePaymentMethodPayPalAdaptive' AdyenApplePay: '#/components/schemas/CreatePaymentMethodApplePayAdyen' AdyenGooglePay: '#/components/schemas/CreatePaymentMethodGooglePayAdyen' GooglePay: '#/components/schemas/CreatePaymentMethodGooglePayChase' AmazonPay: '#/components/schemas/CreatePaymentMethodAmazonPay' oneOf: - $ref: '#/components/schemas/CreatePaymentMethodCreditCard' - $ref: '#/components/schemas/CreatePaymentMethodCCReferenceTransaction' - $ref: '#/components/schemas/CreatePaymentMethodACH' - $ref: '#/components/schemas/CreatePaymentMethodSEPA' - $ref: '#/components/schemas/CreatePaymentMethodBetalingsservice' - $ref: '#/components/schemas/CreatePaymentMethodAutogiro' - $ref: '#/components/schemas/CreatePaymentMethodBacs' - $ref: '#/components/schemas/CreatePaymentMethodBecs' - $ref: '#/components/schemas/CreatePaymentMethodBecsnz' - $ref: '#/components/schemas/CreatePaymentMethodPAD' - $ref: '#/components/schemas/CreatePMPayPalNativeEC' - $ref: '#/components/schemas/CreatePMPayPalCP' - $ref: '#/components/schemas/CreatePMPayPalEC' - $ref: '#/components/schemas/CreatePaymentMethodPayPalAdaptive' - $ref: '#/components/schemas/CreatePaymentMethodApplePayAdyen' - $ref: '#/components/schemas/CreatePaymentMethodGooglePayChase' - $ref: '#/components/schemas/CreatePaymentMethodAmazonPay' required: - type description: Payment method information associated with an account. CreateAccountShipToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for optional ship-to contact; uses the same field structure as the `billToContact` field. If this field is not specified and the `shipToSameAsBillTo` field is `false`, the ship-to contact of the account is empty. title: ShipToContact POSTAccountTypeSoldToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for optional sold-to contact; uses the same field structure as the bill-to contact (above). If a sold-to contact is not specified, one is created from the bill-to contact. Once created, these are two separate data entities, and future changes to one do not affect the other. title: soldToContact POSTAccountTypeSubscription: allOf: - properties: autoRenew: description: | If `true`, auto-renew is enabled. Default is `false`. type: boolean contractEffectiveDate: description: | Effective contract date for this subscription, as `yyyy-mm-dd`. format: date type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as `yyyy-mm-dd`. Default value is dependent on the value of other fields. See Notes section for more details. format: date type: string initialTerm: description: | Duration of the initial subscription term in whole months. Default is 0. format: int64 type: integer invoiceOwnerAccountKey: description: | Invoice owner account number or ID. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). type: string invoiceSeparately: description: | Separates a single subscription from other subscriptions and invoices the charge independently. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. The default value is `false`. Prerequisite: The default subscription setting `Enable Subscriptions to be Invoiced Separately` must be set to `Yes`. type: boolean notes: description: '' type: string renewalTerm: description: | Duration of the renewal term in whole months. Default is 0. format: int64 type: integer serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as `yyyy-mm-dd`. Default value is dependent on the value of other fields. See Notes section for more details. format: date type: string subscribeToRatePlans: description: | Container for one or more rate plans for this subscription. items: $ref: '#/components/schemas/POSTSrpCreateType' type: array subscriptionNumber: description: | Subscription Number. The value can be up to 1000 characters. If you do not specify a subscription number when creating a subscription for the new account, Zuora will generate a subscription number automatically. If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field. type: string termStartDate: description: | The date on which the subscription term begins, as `yyyy-mm-dd`. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string required: - contractEffectiveDate - termType type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' description: | Container for subscription information, used if creating a subscription for the new account at the time of account creation. title: subscription AccountObjectNSFields: description: | Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: Class__NS: description: | Value of the Class field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string CustomerType__NS: description: | Value of the Customer Type field for the corresponding customer account in NetSuite. The Customer Type field is used when the customer account is created in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). enum: - Company - Individual type: string Department__NS: description: | Value of the Department field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the account's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Location__NS: description: | Value of the Location field for the corresponding customer account in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Subsidiary__NS: description: | Value of the Subsidiary field for the corresponding customer account in NetSuite. The Subsidiary field is required if you use NetSuite OneWorld. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the account was sychronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SynctoNetSuite__NS: description: | Specifies whether the account should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). enum: - 'Yes' - 'No' type: string title: accountFieldsNetSuite type: object AccountObjectCustomFields: additionalProperties: description: | Custom fields of the Account object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Account object. title: accountFieldsCustom type: object POSTSrpCreateType: allOf: - properties: chargeOverrides: description: | This optional container is used to override the quantity of one or more product rate plan charges for this subscription. items: $ref: '#/components/schemas/POSTScCreateType' type: array externalCatalogPlanId: description: | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externalIdSourceSystem: description: | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externallyManagedPlanId: description: | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. type: string productRatePlanId: description: | ID of a product rate plan for this subscription. type: string productRatePlanNumber: description: | Number of a product rate plan for this subscription. type: string type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: subscribeToRatePlans SubscriptionObjectQTFields: description: | Container for Subscription fields provided by Zuora Quotes. properties: CpqBundleJsonId__QT: description: | The Bundle product structures from Zuora Quotes if you utilize Bundling in Salesforce. Do not change the value in this field. maxLength: 32 type: string OpportunityCloseDate__QT: description: | The closing date of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. format: date type: string OpportunityName__QT: description: | The unique identifier of the Opportunity. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. maxLength: 100 type: string QuoteBusinessType__QT: description: | The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. maxLength: 32 type: string QuoteNumber__QT: description: | The unique identifier of the Quote. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. maxLength: 32 type: string QuoteType__QT: description: | The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel. This field is used in Zuora data sources to report on Subscription metrics. If the subscription originated from Zuora Quotes, the value is populated with the value from Zuora Quotes. maxLength: 32 type: string title: subscriptionFieldsQT type: object SubscriptionObjectNSFields: description: | Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the subscription's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Project__NS: description: | The NetSuite project that the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SalesOrder__NS: description: | The NetSuite sales order than the subscription was created from. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the subscription was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: subscriptionFieldsNS type: object SubscriptionObjectCustomFields: additionalProperties: description: | Custom fields of the Subscription object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Subscription object. title: subscriptionFieldsCustom type: object POSTScCreateType: allOf: - properties: amendedByOrderOn: description: | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. type: string applyDiscountTo: description: | Specifies the type of charges that you want a specific discount to apply to. Values: * `ONETIME` * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE` type: string billCycleDay: description: | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed. Values: `1`-`31` type: string billCycleType: description: | Specifies how to determine the billing day for the charge. When this field is set to `SpecificDayofMonth`, set the `BillCycleDay` field. When this field is set to `SpecificDayofWeek`, set the `weeklyBillCycleDay` field. Values: * `DefaultFromCustomer` * `SpecificDayofMonth` * `SubscriptionStartDay` * `ChargeTriggerDay` * `SpecificDayofWeek` type: string billingPeriod: description: | Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). Values: * `Month` * `Quarter` * `Semi_Annual` * `Annual` * `Eighteen_Months` * `Two_Years` * `Three_Years` * `Five_Years` * `Specific_Months` * `Subscription_Term` * `Week` * `Specific_Weeks` type: string billingPeriodAlignment: description: | Aligns charges within the same subscription if multiple charges begin on different dates. Values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` type: string billingTiming: description: | Billing timing for the charge for recurring charge types. Not avaliable for one time, usage, and discount charges. Values: * `IN_ADVANCE` (default) * `IN_ARREARS` type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' description: description: | Description of the charge. type: string discountAmount: description: | Specifies the amount of fixed-amount discount. type: number discountLevel: description: | Specifies if the discount applies to the product rate plan only, the entire subscription, or to any activity in the account. Values: * `rateplan` * `subscription` * `account` type: string discountPercentage: description: | Percentage of discount for a percentage discount. type: number endDateCondition: description: | Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date. Values: * `Subscription_End` * `Fixed_Period` * `Specific_End_Date` * `One_Time` type: string excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean excludeItemBookingFromRevenueAccounting: default: false description: | The flag to exclude rate plan charges from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean includedUnits: description: | Specifies the number of units in the base set of units for this charge. Must be >=`0`. type: number isAllocationEligible: description: | This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean isUnbilled: description: | This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean listPriceBase: description: | The list price base for the product rate plan charge. Values: * `Per_Billing_Period` * `Per_Month` * `Per_Week` * `Per_Year` * `Per_Specific_Months` type: string number: description: | Unique number that identifies the charge. Max 50 characters. System-generated if not provided. type: string numberOfPeriods: description: | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. format: int64 type: integer originalOrderDate: description: | The date when the rate plan charge is created through an order or amendment. This field is not updatable. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. format: date type: string overagePrice: description: | Price for units over the allowed amount. type: number overageUnusedUnitsCreditOption: description: | Determines whether to credit the customer with unused units of usage. Values: * `NoCredit` * `CreditBySpecificRate` type: string price: description: | Price for units in the subscription rate plan. type: number priceChangeOption: description: | Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting **Enable Automatic Price Change When Subscriptions are Renewed?** must be set to Yes to use this field. Values: * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` type: string priceIncreasePercentage: description: | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. Value must be a decimal between `-100` and `100`. type: number productRatePlanChargeId: description: | ID of a product rate-plan charge for this subscription. type: string productRatePlanChargeNumber: description: | Number of a product rate-plan charge for this subscription. type: string quantity: description: | Number of units. Must be a decimal >=`0`. When using `chargeOverrides` for creating subscriptions with recurring charge types, the `quantity` field must be populated when the charge model is "Tiered Pricing" or "Volume Pricing". It is not required for "Flat Fee Pricing" charge model. type: number ratingGroup: description: | Specifies a rating group based on which usage records are rated. Possible values: - `ByBillingPeriod` (default): The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. **Note:** - The `ByBillingPeriod` value can be applied for all charge models. - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. - The `ByGroupId` value is only available if you have the Active Rating feature enabled. - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. type: string specificBillingPeriod: description: | Specifies the number of month or week for the charges billing period. Required if you set the value of the `billingPeriod` field to `Specific_Months` or `Specific_Weeks`. format: int64 type: integer specificEndDate: description: | Defines when the charge ends after the charge trigger date. **Note**: * This field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`. * If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. format: date type: string specificListPriceBase: description: | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`. **Note**: - This field is available only if you have the Annual List Price feature enabled. - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. format: int32 maximum: 200 minimum: 1 type: integer tiers: description: | Container for Volume, Tiered, or Tiered with Overage charge models. Supports the following charge types: * One-time * Recurring * Usage-based items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: description: | Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`. format: date type: string triggerEvent: description: | Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD` type: string unusedUnitsCreditRates: description: | Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the `OverageUnusedUnitsCreditOption` field is set to `CreditBySpecificRate`. type: number upToPeriods: description: | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. **Note:** You must use this field together with the `upToPeriodsType` field to specify the time period. * This field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. * If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. format: int64 type: integer upToPeriodsType: description: | The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` You must use this field together with the `upToPeriods` field to specify the time period. This field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. type: string weeklyBillCycleDay: description: | Specifies which day of the week is the bill cycle day (BCD) for the charge. Values: * `Sunday` * `Monday` * `Tuesday` * `Wednesday` * `Thursday` * `Friday` * `Saturday` type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeOverrides RatePlanObjectCustomFields: additionalProperties: description: | Custom fields of the Rate Plan object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Rate Plan object. title: RatePlanCustomFields type: object ChargeModelConfigurationType: description: | Container for charge model configuration data. **Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. These charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. properties: customFieldPerUnitRate: description: | The custom field that carries the per-unit rate for each usage record. For example, `perUnitAmount__c`. This field is only available for the usage-based charges that use the Pre-Rated Per Unit Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. type: string customFieldTotalAmount: description: | The custom field that carries the total amount to charge for a usage record. For example, `totalAmount__c`. This field is only available for the usage-based charges that use the Pre-Rated Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. type: string formula: description: | The pricing formula to calculate actual rating amount for each usage record. This field is only available for the usage-based charges that use the Multi-Attribute Pricing charge model. The charge model is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/C_Zuora_Editions) for pricing information. type: string title: chargeModelConfiguration type: object POSTTierType: properties: endingUnit: description: | End number of a range of units for the tier. type: number price: description: | Price of the tier if the charge is a flat fee, or the price of each unit in the tier if the charge model is tiered pricing. type: number priceFormat: description: | Indicates if pricing is a flat fee or is per unit. Values: * `FlatFee` * `PerUnit` type: string startingUnit: description: | Starting number of a range of units for the tier. type: number tier: description: | Unique number that identifies the tier that the price applies to. format: int64 type: integer required: - tier - price title: tiers type: object RatePlanChargeObjectCustomFields: additionalProperties: description: | Custom fields of the Rate Plan Charge object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Rate Plan Charge object. title: ratePlanChargeFieldsCustom type: object ContactObjectCustomFields: additionalProperties: description: | Custom fields of the Contact object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Contact object. title: contactFieldsCustom type: object CreatePaymentMethodCreditCard: allOf: - type: object properties: type: type: string cardHolderInfo: $ref: '#/components/schemas/CreatePaymentMethodCardholderInfo' cardMaskNumber: description: | The masked card number. Currently, this field is only supported on certain integrations. See this article for more information. type: string cardNumber: description: | Credit card number. type: string cardType: description: | The type of the credit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see Supported Payment Gateways. type: string checkDuplicated: description: | Indicates whether the duplication check is performed when you create a new credit card payment method. The default value is `false`. With this field set to `true`, Zuora will check all active payment methods associated with the same billing account to ensure that no duplicate credit card payment methods are created. An error is returned if a duplicate payment method is found. The following fields are used for the duplication check: - `cardHolderName` - `expirationMonth` - `expirationYear` - `creditCardMaskNumber`. It is the masked credit card number generated by Zuora. For example, `************1234`. **This field is being deprecated.** To achieve the same purpose, use the `processingOptions` > `checkDuplicated` field of the payment method object. type: boolean expirationMonth: description: | One or two digit expiration month (1-12) of the credit card. type: integer expirationYear: description: | Four-digit expiration year of the credit card. type: integer identityNumber: description: | The identity number of the cardholder. This field is required for Credit Card payment methods in certain countries such as Brazil. type: string mitConsentAgreementRef: description: | Specifies your reference for the stored credential consent agreement that you have established with the customer. Only applicable if you set the `mitProfileAction` field. maxLength: 128 type: string mitConsentAgreementSrc: description: | Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field. enum: - External type: string mitNetworkTransactionId: description: | Specifies the ID of a network transaction. Only applicable if you set the `mitProfileAction` field to `Persist`. maxLength: 128 type: string mitProfileAction: description: | Specifies how Zuora creates and activates the stored credential profile. - `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field. enum: - Activate - Persist type: string mitProfileAgreedOn: description: | The date on which the profile is agreed. The date format is `yyyy-mm-dd`. format: date type: string mitProfileType: description: | Required if you set the `mitProfileAction` field. Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field. enum: - Recurring - Unscheduled type: string screeningAmount: description: | For Chase Paymentech Orbital Gateway integrations, if the Safetech Fraud service is enabled, use this field to pass in the amount used for fraud screening for Credit Card validation transactions. Two-decimal amount is supported. If the `screeningAmount` field is not specified, the authorization amount is used for fraud screening. format: decimal type: number securityCode: description: | CVV or CVV2 security code of the credit card. To ensure PCI compliance, this value is not stored and cannot be queried. type: string tokens: description: | To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See this article for more information. properties: gatewayType: description: | The type of the payment gateway to generate the tokens. This field is case-sensitive. type: string secondTokenId: description: | Pass in the second token of the payment method. type: string thirdTokenId: description: | Pass in the third token of the payment method. type: string tokenId: description: | Pass in the first token of the payment method. type: string required: - gatewayType - tokenId type: object tokenize: default: false description: | Specify `true` to tokenize the payment method with the card information. Currently, this field is only supported on certain integrations. See this article for more information. type: boolean mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. type: object properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - cardHolderInfo - cardNumber - cardType - expirationMonth - expirationYear example: accountKey: 8ad09be48db5aba7018db604776d4854 type: CreditCard cardType: Visa cardNumber: '4111111111111111' expirationMonth: 12 expirationYear: 2028 cardHolderInfo: cardHolderName: Amy Lawrence CreatePaymentMethodCCReferenceTransaction: allOf: - type: object properties: type: type: string creditCardMaskNumber: description: | The masked credit card number, such as `*********1112`. This field is specific for the CC Reference Transaction payment method. It is an optional field that you can use to distinguish different CC Reference Transaction payment methods. Though there are no special restrictions on the input string, it is highly recommended to specify a card number that is masked. maxLength: 19 type: string secondTokenId: description: | A gateway unique identifier that replaces sensitive payment method data. `secondTokenId` is conditionally required only when `tokenId` is being used to represent a gateway customer profile. `secondTokenId` is used in the CC Reference Transaction payment method. type: string tokenId: description: | A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. When `tokenId` is used to represent a customer profile, `secondTokenId` is conditionally required for representing the underlying tokenized payment method. The values for the `tokenId` and `secondTokenId` fields differ for gateways. For more information, see the Knowledge Center article specific to each gateway that supports the CC Reference Transaction payment method. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' type: object required: - type - tokenId example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 tokenId: A9xCTM0A3D7g0OOiYnwxJMjkZ6Nn8yMDusVbnhvH secondTokenId: B4D339HPV3KHQQ65 creditCardMaskNumber: '************1111' type: CreditCardReferenceTransaction CreatePaymentMethodACH: allOf: - properties: type: type: string addressLine1: description: | First address line, 255 characters or less. type: string addressLine2: description: | Second address line, 255 characters or less. type: string bankABACode: description: | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. type: string bankAccountMaskNumber: description: | The masked account number such as ****1234. Currently, this field is only supported on certain integrations. See this article for more information. type: string bankAccountName: description: | The name of the account holder, which can be either a person or a company. For ACH payment methods on the BlueSnap integration, see [Overview of BlueSnap gateway integration](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/BlueSnap_Gateway/Overview_of_BlueSnap_gateway_integration#Payer_Name_Extraction) for more information about how Zuora splits the string in this field into two parts and passes them to BlueSnap's `firstName` and `lastName` fields. maxLength: 70 type: string bankAccountNumber: description: | The bank account number associated with the ACH payment. For the creation of tokenized ACH payment methods, this field is optional. Currently, ACH tokenization is supported on selected payment gateway integrations. See this article for more information. maxLength: 30 type: string bankAccountType: description: | The type of bank account associated with the ACH payment. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably. enum: - BusinessChecking - Checking - Saving type: string bankName: description: | The name of the bank where the ACH payment account is held. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value. maxLength: 70 type: string city: description: | City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | Country, must be a valid country name or abbreviation. See View countries or regions for the list of supported country names and abbreviations. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string phone: description: | Phone number, 40 characters or less. type: string state: description: | State, must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string zipCode: description: | Zip code, 20 characters or less. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object tokens: description: | To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See this article for more information. properties: gatewayType: description: | The type of the payment gateway to generate the tokens. This field is case-sensitive. type: string secondTokenId: description: | Pass in the second token of the payment method. type: string thirdTokenId: description: | Pass in the third token of the payment method. type: string tokenId: description: | Pass in the first token of the payment method. type: string type: object required: - gatewayType - tokenId tokenize: default: false description: | Specify `true` to tokenize the payment method with the account information. Currently, this field is only supported on certain integrations. See this article for more information. type: boolean type: object title: AchPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - bankABACode - bankAccountName - bankAccountNumber - bankAccountType - bankName example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 bankABACode: '999999999' bankAccountName: TestName bankAccountNumber: '999999999' bankAccountType: Checking bankName: TestBank addressLine1: Test Address line1 addressLine2: Test Address line2 phone: '1234567890' city: testCity country: USA state: Alaska zipCode: '123456' processingOptions: checkDuplicated: true type: ACH CreatePaymentMethodSEPA: allOf: - properties: type: type: string IBAN: description: | The International Bank Account Number. This field is required if the `type` field is set to `SEPA`. However, for the creation of tokenized SEPA payment methods, this field is optional. Currently, SEPA tokenization is supported on selected payment gateway integrations. See this article for more information. type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. However, for the creation of tokenized SEPA payment methods, this field is optional. Currently, SEPA tokenization is supported on selected payment gateway integrations. See this article for more information. properties: accountHolderName: description: | The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object required: - accountHolderName accountMaskNumber: description: | The masked account number such as ****1234. When creating tokenized SEPA payment methods, this `accountMaskNumber` field is required if the `tokens` field is provided. Currently, SEPA tokenization is supported on selected payment gateway integrations. See this article for more information. type: string businessIdentificationCode: description: | The BIC code used for SEPA. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object tokenize: default: false description: | When creating a SEPA payment method on Adyen Integration v2.0, use this field to specify whether to tokenize the payment method with IBAN. If `tokenize` is `true`, `IBAN` is required. If the `tokens` field is provided, this `tokenize` field is not required. For more information about how to create tokenized SEPA payment methods on Adyen, see Tokenize SEPA payment methods on Adyen Integration v2.0. type: boolean tokens: description: | To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, SEPA tokenization is supported on selected payment gateway integrations. See this article for more information. properties: gatewayType: description: | The type of the payment gateway to generate the tokens. This field is case-sensitive. enum: - Adyen - Stripe type: string secondTokenId: description: | Pass in the second token of the payment method. type: string thirdTokenId: description: | Pass in the third token of the payment method. type: string tokenId: description: | Pass in the first token of the payment method. type: string type: object required: - gatewayType - tokenId processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - IBAN - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 IBAN: FR1420041010050500013M02606 accountHolderInfo: accountHolderName: TestName processingOptions: checkDuplicated: true type: SEPA CreatePaymentMethodBetalingsservice: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string identityNumber: description: | The identity number used for Bank Transfer. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - identityNumber - bankCode - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: '3179681' identityNumber: '0101701234' bankCode: '345' accountHolderInfo: accountHolderName: TestName processingOptions: checkDuplicated: true type: Betalingsservice CreatePaymentMethodAutogiro: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. type: string branchCode: description: | The branch code of the bank used for direct debit. type: string identityNumber: description: | The identity number used for Bank Transfer. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object title: AutogiroPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - identityNumber - branchCode - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: '0000003' identityNumber: '198112289874' branchCode: '5491' accountHolderInfo: accountHolderName: TestName processingOptions: checkDuplicated: true type: Autogiro CreatePaymentMethodBacs: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. When creating BACS payment methods on Stripe, if the `tokens` field is provided, this `accountMaskNumber` field is required. For more information, see Overview of Stripe payment gateway integration. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object tokenize: default: false description: | When creating a BACS payment method on Adyen v2.0, set this field to `true` to support processing BACS recurring payments. For more information about other requirements for processing BACS recurring payments, see Overview of Adyen Integration v2.0. type: boolean tokens: description: | To create tokenized BACS payment methods on Stripe v2, pass in the existing token information through the fields in this container. For more information, see Overview of Stripe payment gateway integration. properties: gatewayType: description: | Required. The type of the payment gateway to generate the tokens. This field is case-sensitive. enum: - Stripe type: string secondTokenId: description: | Pass in the second token of the payment method. For more information, see Overview of Stripe payment gateway integration. type: string thirdTokenId: description: | Pass in the third token of the payment method. type: string tokenId: description: | Required. Pass in the first token of the payment method. For more information, see Overview of Stripe payment gateway integration. type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object title: BacsPaymentMethod - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: '55779911' bankCode: '200000' accountHolderInfo: accountHolderName: TestName processingOptions: checkDuplicated: true type: Bacs CreatePaymentMethodBecs: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. type: string branchCode: description: | The branch code of the bank used for direct debit. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - branchCode example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: '012345678' branchCode: 082-082 accountHolderInfo: accountHolderName: TestName processingOptions: checkDuplicated: true type: Becs CreatePaymentMethodBecsnz: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. type: string branchCode: description: | The branch code of the bank used for direct debit. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - branchCode - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: 0003869-00 accountHolderInfo: accountHolderName: TestName branchCode: '3113' bankCode: '12' processingOptions: checkDuplicated: true type: Becsnz CreatePaymentMethodPAD: allOf: - properties: type: type: string accountHolderInfo: description: | The container for the account holder information. The nested `accountHolderName` field is required. properties: accountHolderName: description: | Required. The full name of the bank account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | The country where the account holder stays. type: string email: description: | The email address of the account holder. type: string firstName: description: | The first name of the account holder. type: string lastName: description: | The last name of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string type: object accountNumber: description: | The number of the customer's bank account. type: string accountMaskNumber: description: | The masked account number such as ****1234. type: string branchCode: description: | The branch code of the bank used for direct debit. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string mandateInfo: description: | The container of the mandate information for the payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method. The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - accountNumber - bankCode - branchCode - accountHolderInfo example: accountKey: 8a90d6128d45df2b018d4b90681c05x0 accountNumber: '0000000' accountHolderInfo: accountHolderName: TestName branchCode: '00006' bankCode: '0003' processingOptions: checkDuplicated: true type: PAD CreatePMPayPalCP: allOf: - properties: type: type: string BAID: description: | ID of a PayPal billing agreement. type: string example: I-1TJ3GAGG82Y9 email: description: | Email address associated with the payment method. type: string tokens: description: | To create tokenized payment methods, pass in the existing token information through the fields in this container. Currently, this field is only supported on certain integrations. See this article for more information. properties: gatewayType: description: | The type of the payment gateway to generate the tokens. This field is case-sensitive. type: string secondTokenId: description: | Pass in the second token of the payment method. type: string thirdTokenId: description: | Pass in the third token of the payment method. type: string tokenId: description: | Pass in the first token of the payment method. type: string required: - gatewayType - tokenId type: object tokenize: default: false description: | Specify `true` to tokenize the payment method. Currently, this field is only supported on certain integrations. See this article for more information. type: boolean type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID - email example: BAID: I-1TJ3GAGG82Y9 accountKey: 8a90d6128d45df2b018d4b90681c05x0 email: customer@example.com type: PayPalCP CreatePMPayPalEC: allOf: - properties: type: type: string BAID: description: | ID of a PayPal billing agreement. type: string example: I-1TJ3GAGG82Y9 email: description: | Email address associated with the payment method. type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID - email example: BAID: I-1TJ3GAGG82Y9 accountKey: 8a90d6128d45df2b018d4b90681c05x0 email: customer@example.com type: PayPalEC CreatePMPayPalNativeEC: allOf: - properties: type: type: string BAID: description: | ID of a PayPal billing agreement. example: I-1TJ3GAGG82Y9 type: string email: description: | Email address associated with the payment method. type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - BAID example: BAID: I-1TJ3GAGG82Y9 accountKey: 8a90d6128d45df2b018d4b90681c05x0 email: customer@example.com type: PayPalNativeEC CreatePaymentMethodPayPalAdaptive: allOf: - properties: type: type: string preapprovalKey: description: | The PayPal preapproval key. type: string email: description: | Email address associated with the payment method. type: string format: email type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' required: - type - preapprovalKey - email example: preapprovalKey: PA-3X000000LS390262X accountKey: 8a90d6128d45df2b018d4b90681c05x0 email: customer@example.com type: PayPalAdaptive CreatePaymentMethodApplePayAdyen: allOf: - properties: type: type: string applePaymentData: description: | This field is specific for setting up Apple Pay for Adyen to include payload with Apple Pay token or Apple payment data. This information should be stringified. For more information, see [Set up Adyen Apple Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay). type: string email: type: string format: email description: | Email address associated with the payment method. This field is specific for setting up Apple Pay on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`. type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - applePaymentData example: accountKey: 2c92c0f97911f46a0179147510484b90 type: AdyenApplePay email: testemail@test.com applePaymentData: '{"data":"hM8GTBX0UVhoKmJ/DkneZfwLlH/utWfEueshybbTpuzlf5i1IwO1kvW32SlFW7TmyvU98gf2Pp1FeyFCh7F2atmstxQdonkeJgpIUV7eWW1wUNaOeND28J8YQsEkDhC3sMgOJoju7FHcXNwveq5fk94StFZozRSi08oAjTnTJko5F32aY/JNWr19GiwWBHZe2jkokryt0TEWKO5hm5oTxeLs1LBOoC2ezaR+p2jQb4ISN2aCgCNiX8605w5eYWk7UCTK3Axf/EuJT4vHe75OKghEmcQLxvFzTtEw33ly6Nj2RJX3+I5TbYLXOfiAO0XnsWdhguDrKogtI44HMFqlNCdt79G71tXwCwbXz0VJywEh1d57tbU5Y5f6pw8TrjjeAMt9sa2pHuHmMGDf","signature":"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID5DCCA4ugAwIBAgIIWdihvKr0480wCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTIxMDQyMDE5MzcwMFoXDTI2MDQxOTE5MzY1OVowYjEoMCYGA1UEAwwfZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtU0FOREJPWDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEgjD9q8Oc914gLFDZm0US5jfiqQHdbLPgsc1LUmeY+M9OvegaJajCHkwz3c6OKpbC9q+hkwNFxOh6RCbOlRsSlaOCAhEwggINMAwGA1UdEwEB/wQCMAAwHwYDVR0jBBgwFoAUI/JJxE+T5O8n5sT2KGw/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFAIkMAua7u1GMZekplopnkJxghxFMA4GA1UdDwEB/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0cAMEQCIHShsyTbQklDDdMnTFB0xICNmh9IDjqFxcE2JWYyX7yjAiBpNpBTq/ULWlL59gBNxYqtbFCn1ghoN5DgpzrQHkrZgTCCAu4wggJ1oAMCAQICCEltL786mNqXMAoGCCqGSM49BAMCMGcxGzAZBgNVBAMMEkFwcGxlIFJvb3QgQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE0MDUwNjIzNDYzMFoXDTI5MDUwNjIzNDYzMFowejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8BcRhBnXZIXVGl4lgQd26ICi7957rk3gjfxLk+EzVtVmWzWuItCXdg0iTnu6CP12F86Iy3a7ZnC+yOgphP9URaOB9zCB9DBGBggrBgEFBQcBAQQ6MDgwNgYIKwYBBQUHMAGGKmh0dHA6Ly9vY3NwLmFwcGxlLmNvbS9vY3NwMDQtYXBwbGVyb290Y2FnMzAdBgNVHQ4EFgQUI/JJxE+T5O8n5sT2KGw/orv9LkswDwYDVR0TAQH/BAUwAwEB/zAfBgNVHSMEGDAWgBS7sN6hWDOImqSKmd6+veuv2sskqzA3BgNVHR8EMDAuMCygKqAohiZodHRwOi8vY3JsLmFwcGxlLmNvbS9hcHBsZXJvb3RjYWczLmNybDAOBgNVHQ8BAf8EBAMCAQYwEAYKKoZIhvdjZAYCDgQCBQAwCgYIKoZIzj0EAwIDZwAwZAIwOs9yg1EWmbGG+zXDVspiv/QX7dkPdU2ijr7xnIFeQreJ+Jj3m1mfmNVBDY+d6cL+AjAyLdVEIbCjBXdsXfM4O5Bn/Rd8LCFtlk/GcmmCEm9U+Hp9G5nLmwmJIWEGmQ8Jkh0AADGCAYswggGHAgEBMIGGMHoxLjAsBgNVBAMMJUFwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIENBIC0gRzMxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUwIIWdihvKr0480wDQYJYIZIAWUDBAIBBQCggZUwGAYJKoZIhvcNAQkDMQsGCSqGSIb3DQEHATAcBgkqhkiG9w0BCQUxDxcNMjEwNjAzMTgzNzExWjAqBgkqhkiG9w0BCTQxHTAbMA0GCWCGSAFlAwQCAQUAoQoGCCqGSM49BAMCMC8GCSqGSIb3DQEJBDEiBCCiDFBojwOJgYgEzWaGdLTMez4XiDpYJd34PswTPVdt+DAKBggqhkjOPQQDAgRGMEQCIHAWYyr/s28rtd/khGapLi1jCg3iXwgUfL2l4XadiKq3AiBHuronD982WBP3x0Tzc51rXwMEVpL+GDPme9Ydn2MF2gAAAAAAAA==", "header": { "publicKeyHash":"vJeh5XAkv8SGX2JHswEbnCUPn01YHcQ6imAp+gP300w=", "ephemeralPublicKey":"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEVx9kP/eFM6MrP5sXKuzHT7f9Uhsc0Rox0FKvRpHIiqQ05EXYPsgBJZCEjOYlkviC2jDSvV6tEC8Kfq/z/GhrFA==", "transactionId":"7fd9ede5ea8c1d7a8985346c241a8933190a1acb408448c52ac27f7862f674ff" }, "version":"EC_v1" }' CreatePaymentMethodGooglePayAdyen: allOf: - properties: type: type: string googlePaymentToken: description: | This field is specific for setting up Google Pay for Adyen gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Adyen Google Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay). type: string email: description: | Email address associated with the payment method. This field is specific for setting up Google Pay on Adyen v2.0. This field will be passed to Adyen as `shopperEmail`. type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - googlePaymentToken example: accountKey: 2c92c0f97911f46a0179147510484b90 type: AdyenGooglePay email: testemail@test.com googlePaymentToken: '{"signature":"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\u003d","protocolVersion":"ECv1","signedMessage":"{\"encryptedMessage\":\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\",\"ephemeralPublicKey\":\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\u003d\",\"tag\":\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\u003d\"}"}' CreatePaymentMethodGooglePayChase: allOf: - properties: type: type: string googlePaymentToken: description: | This field is specific for setting up Google Pay on Chase gateway integrations to specify the stringified Google Pay token. For more information, see [Set up Google Pay on Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase). type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - googlePaymentToken example: accountKey: 2c92c0f97911f46a0179147510484b90 type: GooglePay googlePaymentToken: '{"signature":"MEUCICeJTEEW+a9ak93yk8pYg4xGlPJbrBNjD8b6vahxD5TRAiEAyMiNhzosJDl2N46Dojzc53bwbT/O0t+VToLCqr01qs4\u003d","protocolVersion":"ECv1","signedMessage":"{\"encryptedMessage\":\"aXpc95j3gEFJfaHF8PEpybNuV/k/IDKMa/FkbNnj2p/uaH8ll99hAUwWkH5EnHr2NwNgLuj3j9IhDomWI9gJ4n2fQlsQ9FsNuqsJjct/QuNvlzooLhu76HlzE3mScXcTUqPI1fgC8s/CVNz06aCUd7/oNMzyCw6VploO9abxp3zcpRvAO39bScaO3fri2Kl0WGozyiS0egXcUzMOpPxDw03SjmpgU/X5FjmxayOBUNxM9r/yOQyvY9mTUHOK855XVl3Xf9dpj6GDnDMp4bvCW8zpXWr76Snwtvv41dIaLxNWsBP0lS5PpJ5K1/rSRZg/dauIKQbWGmTTL24vz4Om7hVu25L7XrSM6F2PRUE4rqMblVDvXAlVsD+149r2fjXsB4DXmvGmwaDcuFeTDuI3ov7GDetgW3Fdl+n7RtBOK/luJYs76a9nPbVLhN/aKU5Hpd0ZrIO8ZUOoUYr6WuecD24tTzwic3k921eLJez8IJnG1k05kiqPpHEqMeLyP/WovjH/U7Vu3iDrH4yAxMEuh0MMi0tTgjXlVEezVnsU\",\"ephemeralPublicKey\":\"BGNnBpAd6WypQEYJmDH/DhUZ9mX2b/wJK6as8g6hZmDCDpHSWFC1BZ42UBrX/hrF/UarrT24CMcWLZp6fYl6PNw\\u003d\",\"tag\":\"j9fPmiEL/zj8R+0JRrTC1NgV9VVCYQ9zYaB7uZrEz9U\\u003d\"}"}' CreatePaymentMethodAmazonPay: allOf: - properties: type: type: string amazonPayToken: description: | This field is specific for setting up Amazon Pay gateway integrations to specify the stringified Amazon Pay token. type: string type: object - $ref: '#/components/schemas/PaymentMethodCommonFields' required: - type - amazonPayToken example: amazonPayToken: C03-0739300-4671639 amazonPayRegion: JP accountKey: 2c92c0f97911f46a0179147510484b90 PaymentMethodCommonFields: properties: accountKey: description: | The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation. type: string authGateway: description: | Internal ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. If you do not set this field, Zuora will use one of the following payment gateways instead: * The default payment gateway of the customer account that owns the payment method, if the `accountKey` field is set. * The default payment gateway of your Zuora tenant, if the `accountKey` field is not set. If Payment Gateway Routing is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment. type: string currencyCode: description: | The currency used for payment method authorization. type: string example: USD gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object example: shopperInteraction: POS shopperEmail: testemail@test.com ipAddress: description: | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required. type: string makeDefault: default: false description: | Specifies whether the payment method will be the default payment method of the customer account that owns the payment method. Only applicable if the `accountKey` field is set. When you set this field to `true`, make sure the payment method is supported by the default payment gateway. type: boolean skipValidation: default: false description: | Specify whether to skip the validation of the information through the payment gateway. For example, when migrating your payment methods, you can set this field to `true` to skip the validation. type: boolean type: description: | Type of the payment method. The following types of the payment methods are supported: * `CreditCard` * `CreditCardReferenceTransaction` * `ACH` * `SEPA` * `Betalingsservice` * `Autogiro` * `Bacs` * `Becs` * `Becsnz` * `PAD` * `PayPalCP` * `PayPalEC` * `PayPalNativeEC` * `PayPalAdaptive` * `AdyenApplePay` * `AdyenGooglePay` * `GooglePay` * `AmazonPay` To view the schema and example applicable to a specific payment method type, select the corresponding option from the following list. type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay - AmazonPay type: object PaymentMethodObjectCustomFields: additionalProperties: description: | Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a payment method object. title: paymentMethodFieldsCustom type: object CreatePaymentMethodCardholderInfo: description: "Container for cardholder information. The nested\_`cardHolderName`\_field is required.\n" properties: addressLine1: description: | First address line, 255 characters or less. type: string addressLine2: description: | Second address line, 255 characters or less. type: string cardHolderName: description: | The card holder's full name as it appears on the card, e.g., "John J Smith", 50 characters or less. type: string city: description: | City, 40 characters or less. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string country: description: | Country, must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string email: description: | Card holder's email address, 80 characters or less. type: string phone: description: | Phone number, 40 characters or less. type: string state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string zipCode: description: | Zip code, 20 characters or less. type: string required: - cardHolderName title: cardHolderInfo type: object example: cardHolderName: Amy Lawrence addressLine1: 101 Redwood Shores Parkway city: Redwood City state: CA zipCode: 94065 country: USA phone: (888) 976-9056 EinvoiceObjectCustomFields: additionalProperties: description: | Custom fields of the eInvoiceProfile object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Manage custom fields for more information. description: | Container for custom fields of an EinvoiceProfile object. title: eInvoiceProfileCustomFields type: object DeleteAccountResponseType: properties: id: description: | The ID of the deleted account. type: string jobId: description: | The ID of the job that handles the account deletion operation. You can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/) API operation to query job information. type: string jobStatus: description: | The status of the account deletion operation. enum: - Pending type: string reasons: items: properties: code: description: | The error code of the response. type: string message: description: | The detail information of the error response. type: string type: object type: array success: description: | Whether the call succeeded. type: boolean type: object GETAccountType: properties: basicInfo: $ref: '#/components/schemas/GETAccountTypeBasicInfo' billToContact: $ref: '#/components/schemas/GETAccountTypeBillToContact' billingAndPayment: description: Container for billing and payment information for the account. properties: additionalEmailAddresses: description: | A list of additional email addresses to receive email notifications. items: type: string type: array autoPay: description: |+ Whether future payments are automatically collected when they are due during a payment run. type: boolean billCycleDay: description: | Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. format: int64 type: integer currency: description: | A currency defined in the web-based UI administrative settings. type: string defaultPaymentMethodId: description: | ID of the default payment method for the account. type: string invoiceDeliveryPrefsEmail: description: | Whether the customer wants to receive invoices through email. type: boolean invoiceDeliveryPrefsPrint: description: | Whether the customer wants to receive printed invoices, such as through postal mail. type: boolean paymentMethodCascadingConsent: description: | `true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. type: boolean paymentGateway: description: | The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. type: string paymentTerm: description: | A payment-terms indicator defined in the web-based UI administrative settings, e.g., "Net 30". type: string type: object einvoiceProfile: $ref: '#/components/schemas/GetAccountEInvoiceProfile' gatewayRoutingEligible: description: | Returns `true` if the applicable billing accounts were was processed successfully for gateway routing . type: boolean metrics: description: | Container for account metrics of the account's default currency. If you have the Multiple Currencies feature enabled, the `metricsData` field provides account metrics of different currencies. properties: balance: description: | The customer's total invoice balance minus credit balance. format: decimal type: string contractedMrr: description: | Future expected MRR that accounts for future upgrades, downgrades, upsells and cancellations. format: decimal type: string creditBalance: description: | Current credit balance. format: decimal type: string reservedPaymentAmount: description: | The Reserved Payment Amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. format: float type: number totalDebitMemoBalance: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total balance of all posted debit memos. format: decimal type: string totalInvoiceBalance: description: | Total balance of all posted invoices. format: decimal type: string unappliedCreditMemoAmount: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total unapplied amount of all posted credit memos. format: decimal type: string unappliedPaymentAmount: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. Total unapplied amount of all posted payments. format: decimal type: string type: object metricsData: description: | Container for account metrics of different currencies. **Note**: This field is available only if you have the Multiple Currencies feature enabled. items: $ref: '#/components/schemas/GETAccountCurrencyMetricsType' type: array shipToContact: $ref: '#/components/schemas/GetAccountTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountTypeSoldToContact' success: description: | Returns `true` if the request was processed successfully. type: boolean taxInfo: description: | Container for tax exempt information, used to establish the tax exempt status of a customer account. properties: VATId: description: | EU Value Added Tax ID. type: string companyCode: description: | Unique code that identifies a company account in Avalara. type: string exemptCertificateId: description: | ID of the customer tax exemption certificate. type: string exemptCertificateType: description: | Type of tax exemption certificate that the customer holds. type: string exemptDescription: description: | Description of the tax exemption certificate that the customer holds. type: string exemptEffectiveDate: description: | Date when the customer tax exemption starts. format: date type: string exemptEntityUseCode: description: | A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. maxLength: 64 type: string exemptExpirationDate: description: | Date when the customer tax exemption expires. format: date type: string exemptIssuingJurisdiction: description: | Jurisdiction in which the customer tax exemption certificate was issued. type: string exemptStatus: description: | Status of the account tax exemption. type: string type: object type: object GETAccountTypeBasicInfo: allOf: - properties: accountNumber: description: | Account number. type: string batch: description: | The alias name given to a batch. A string of 50 characters or less. type: string communicationProfileId: description: The ID of the communication profile that this account is linked to. type: string creditMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. type: string crmId: description: | CRM account ID for the account, up to 100 characters. type: string customerServiceRepName: description: | Name of the account's customer service representative, if applicable. maxLength: 50 type: string debitMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. type: string id: description: | Account ID. type: string invoiceTemplateId: description: | Invoice template ID, configured in Billing Settings in the Zuora UI. type: string nullable: true lastMetricsUpdate: description: | The date and time when account metrics are last updated, if the account is a partner account. **Note**: - This field is available only if you have the Reseller Account feature enabled. - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated. format: date-time type: string name: description: | Account name. type: string notes: description: | Notes associated with the account, up to 65,535 characters. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string parentId: description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled. type: string partnerAccount: description: | Whether the customer account is a partner, distributor, or reseller. **Note**: This field is available only if you have the Reseller Account feature enabled. type: boolean profileNumber: description: The number of the communication profile that this account is linked to. type: string purchaseOrderNumber: description: The purchase order number provided by your customer for services, products, or both purchased. type: string salesRep: description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. type: string sequenceSetId: description: | The ID of the billing document sequence set that is assigned to the customer account. type: string nullable: true summaryStatementTemplateId: description: The summary statement template ID. When a user attempts to generate a summary statement from the "Account Summary Statement" screen, the system utilizes this template to produce the PDF. type: string nullable: true status: description: | Account status; possible values are: `Active`, `Draft`, `Canceled`. type: string tags: description: '' type: string type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' description: | Container for basic information about the account. **Notes**: - In the "Retrieve an order" operation, if the `getAccountDetails` query parameter is set to `true`, the subscription owner account details `subscriptionOwnerAccountDetails` and invoice owner account details `existingAccountDetails` will be in the response. - In the "Retrieve a subscription by key" operation, the returned result differs based on the following query parameters: - If the `getSubscriptionOwnerDetails` query parameter is set to `true`, the subscription owner account details `accountOwnerDetails` will be in the response. - If the `getInvoiceOwnerDetails` query parameter is set to `true`, the invoice owner account details `invoiceOwnerAccountDetails` will be in the response. - If both query parameters are set to `true`, the subscription owner account details `accountOwnerDetails` and invoice owner account details `invoiceOwnerAccountDetails` will be in the response. title: basicInfo GETAccountTypeBillToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. ' type: string nullable: true fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string id: description: ID of the person to bill for the account, 32 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact. type: string otherPhone: description: | Other phone number, 40 characters or less. type: string nullable: true otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string nullable: true personalEmail: description: | Personal email address. type: string maxLength: 80 state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string nullable: true workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for bill-to contact information. title: Contact GetAccountEInvoiceProfile: description: | Container for e-invoicing profile information for this account. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. allOf: - properties: businessCategory: description: | The high-level category of the business. type: string enum: - B2B - B2C - B2G businessName: description: | The full official name that the Buyer is registered with the relevant legal authority. maxLength: 255 type: string businessNumber: description: | The unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India. type: string businessNumberSchemeId: description: | The identification scheme identifier that an official registrar issues to identify the Buyer as a legal entity or person. type: string enabled: description: | Whether the e-invoicing profile for the customer account is enabled. If the following conditions are met, all billing documents for one account can be submitted to an e-invoicing service provider to be generated in electronic format: - The account must be configured to generate e-invoice files for billing documents. - The billing document must be in Posted status. - A business region must be created for the billing country contact, and be linked to an e-invoicing service provider. type: boolean endpointId: description: | The Buyer's electronic address, to which the application-level response to the billing document might be delivered. type: string endpointSchemeId: description: | The identification scheme identifier of the Buyer’s electronic address. type: string taxRegisterNumber: description: | The Buyer's VAT identifier (also known as the Buyer's VAT identification number) or the local identification (defined by the Buyer’s address) of the Buyer for tax purposes, or a reference that enables the Buyer to state the registered tax status. type: string title: einvoiceProfile type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' GETAccountCurrencyMetricsType: allOf: - properties: balance: description: | The total balance in this currency. type: string contractedMrr: description: | The future expected Monthly Recurring Revenue (MRR) in this currency, accounting for future upgrades, downgrades, upsells, and cancellations. format: decimal type: string currency: description: | The currency that metrics are aggregated based on. type: string reservedPaymentAmount: description: | The reserved payment amount of the customer account in this currency. For more information, see Prepaid Cash with Drawdown. format: decimal type: string totalDebitMemoBalance: description: | The total balance of all posted debit memos in this currency. **Note:** This field is only available if you have 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 for more information. format: decimal type: string totalInvoiceBalance: description: | The total balance of all posted invoices in this currency. format: decimal type: string unappliedCreditMemoAmount: description: | The total unapplied amount of all posted credit memos in this currency. format: decimal type: string unappliedPaymentAmount: description: | The total unapplied amount of all posted payments in this currency. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. format: decimal type: string type: object title: metricsData GetAccountTypeShipToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora tax uses this information to calculate county taxation. ' type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string id: description: ID of the person who bought the subscription associated with the account, 32 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact. type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string maxLength: 80 state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for ship-to contact information. Uses the same field structure as billToContact. title: Contact GETAccountTypeSoldToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora tax uses this information to calculate county taxation. ' type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string id: description: ID of the person who bought the subscription associated with the account, 32 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact. type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string maxLength: 80 state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for sold-to contact information. Uses the same field structure as billToContact. title: Contact PUTAccountType: allOf: - properties: additionalEmailAddresses: description: | A list of additional email addresses to receive email notifications. Use commas to separate email addresses. items: type: string type: array autoPay: description: | Whether future payments are to be automatically billed when they are due. type: boolean batch: description: | The alias name given to a batch. A string of 50 characters or less. **Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package. type: string billCycleDay: description: | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month the customer is billed. Values: Any activated system-defined bill cycle day （`1`-`31`） maxLength: 2 type: integer billToContact: $ref: '#/components/schemas/PUTAccountTypeBillToContact' billToContactId: description: | The ID of a contact that will be the bill-to contact of the current account. type: string communicationProfileId: description: | The ID of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile. type: string creditMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the credit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08a6246fdf101626b1b3fe0144b. type: string crmId: description: | CRM account ID for the account, up to 100 characters. type: string customerServiceRepName: description: | Name of the account’s customer service representative, if applicable. maxLength: 50 type: string debitMemoTemplateId: description: | **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. The unique ID of the debit memo template, configured in **Billing Settings** > **Manage Billing Document Configuration** through the Zuora UI. For example, 2c92c08d62470a8501626b19d24f19e2. type: string defaultPaymentMethodId: description: | ID of the default payment method for the account. Values: a valid ID for an existing payment method. maxLength: 64 type: string einvoiceProfile: $ref: '#/components/schemas/PUTAccountEinvoiceProfile' gatewayRoutingEligible: default: false description: | Indicates whether to include the applicable billing accounts to gateway routing for controlled adoption. type: boolean invoiceDeliveryPrefsEmail: description: | Whether the customer wants to receive invoices through email. The default value is `false`. type: boolean invoiceDeliveryPrefsPrint: description: | Whether the customer wants to receive printed invoices, such as through postal mail. The default value is `false`. type: boolean invoiceTemplateId: description: | Invoice template ID, configured in Billing Settings in the Zuora UI. type: string name: description: | Account name, up to 255 characters. type: string notes: description: | A string of up to 65,535 characters. type: string parentId: description: Identifier of the parent customer account for this Account object. The length is 32 characters. Use this field if you have Customer Hierarchy enabled. type: string partnerAccount: default: false description: | Whether the customer account is a partner, distributor, or reseller. You can set this field to `true` if you have business with distributors or resellers, or operating in B2B model to manage numerous subscriptions through concurrent API requests. After this field is set to `true`, the calculation of account metrics is performed asynchronously during operations such as subscription creation, order changes, invoice generation, and payments. **Note**: This field is available only if you have the Reseller Account feature enabled. type: boolean paymentGateway: description: | The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. type: string paymentTerm: description: Payment terms for this account. Possible values are `Due Upon Receipt`, `Net 30`, `Net 60`, `Net 90`. type: string profileNumber: description: | The number of the communication profile that this account is linked to. You can provide either or both of the `communicationProfileId` and `profileNumber` fields. If both are provided, the request will fail if they do not refer to the same communication profile. type: string purchaseOrderNumber: description: The purchase order number provided by your customer for services, products, or both purchased. type: string salesRep: description: The name of the sales representative associated with this account, if applicable. Maximum of 50 characters. type: string sequenceSetId: description: | The ID of the billing document sequence set to assign to the customer account. The billing documents to generate for this account will adopt the prefix and starting document number configured in the sequence set. If a customer account has no assigned billing document sequence set, billing documents generated for this account adopt the prefix and starting document number from the default sequence set. type: string nullable: true shipToContact: $ref: '#/components/schemas/UpdateAccountShipToContact' shipToContactId: description: | The ID of a contact that will be the ship-to contact of the current account. type: string soldToContact: $ref: '#/components/schemas/PUTAccountTypeSoldToContact' soldToContactId: description: | The ID of a contact that will be the sold-to contact of the current account. type: string tagging: description: '' type: string summaryStatementTemplateId: description: | The summary statement template ID or number. When a user attempts to generate a summary statement from the "Account Summary Statement" screen, the system utilizes this template to produce the PDF. type: string taxInfo: description: | Container for tax exempt information, used to establish the tax exempt status of a customer account. properties: VATId: description: | EU Value Added Tax ID. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). type: string companyCode: description: | Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com). type: string exemptCertificateId: description: | ID of the customer tax exemption certificate. Requires Zuora Tax. type: string exemptCertificateType: description: | Type of tax exemption certificate that the customer holds. Requires Zuora Tax. type: string exemptDescription: description: | Description of the tax exemption certificate that the customer holds. Requires Zuora Tax. type: string exemptEffectiveDate: description: | Date when the customer tax exemption starts. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date. format: date type: string exemptEntityUseCode: description: | A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. maxLength: 64 type: string exemptExpirationDate: description: | Date when the customer tax exemption expires. Requires Zuora Tax. Format: `yyyy-mm-dd`. Defaults to the current date. format: date type: string exemptIssuingJurisdiction: description: | Jurisdiction in which the customer tax exemption certificate was issued. type: string exemptStatus: description: | Status of the account tax exemption. Requires Zuora Tax. Required if you use Zuora Tax. This field is unavailable if Zuora Tax is not used. Values: `Yes`, `No`(default), `pendingVerification`. Note that the value will be set to `No` if no input. type: string type: object type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' example: billCycleDay: 1 PUTAccountTypeBillToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for bill-to contact information for this account. title: Contact PUTAccountEinvoiceProfile: allOf: - properties: businessCategory: description: | The high-level category of the business. type: string enum: - B2B - B2C - B2G businessName: description: 'Legal Business Name. The full formal name by which the Buyer is registered with the relevant legal authority. ' maxLength: 255 type: string businessNumber: description: 'Buyer legal registration identifier. An identifier issued by an official registrar that identifies the Buyer as a legal entity or person. GSTIN of buyer for India. ' type: string businessNumberSchemeId: description: 'Business Number Schema Id. The identification scheme identifier of the Buyer legal registration identifier. ' type: string enabled: description: 'Enable e-invoice for the account. All invoices generated from this account can be submitted to generate e-invoices when invoices meet the conditions: A business region must be created for the billing country contact, and it must be linked to a service provider. The account must be enabled to generate e-invoices. The invoice must be in the "Posted" status. ' type: boolean endpointId: description: | Buyer electronic address.Identifies the Buyer's electronic address to which the invoice is delivered. type: string endpointSchemeId: description: 'Buyer electronic address identification scheme identifier. ' type: string taxRegisterNumber: description: | Buyer VAT identifier. The Buyer's VAT identifier (also known as Buyer VAT identification number). type: string type: object - $ref: '#/components/schemas/EinvoiceObjectCustomFields' description: | Container for profile information for this account. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. title: einvoiceProfile UpdateAccountShipToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for optional ship-to contact. title: Contact PUTAccountTypeSoldToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. type: string country: description: | Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the sold-to contact to calculate tax. A bill-to contact may be used if no sold-to contact is provided. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. type: string fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string homePhone: description: | Home phone number, 40 characters or less. type: string lastName: description: | Last name, 100 characters or less. type: string mobilePhone: description: | Mobile phone number, 40 characters or less. type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. type: string format: email maxLength: 80 state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the sold-to contact to calculate tax, and that a bill-to contact may be used if no sold-to contact is provided. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for optional sold-to contact. title: Contact GETAccountPaymentMethodType: allOf: - properties: defaultPaymentMethodId: description: | ID of the default payment method for the account. type: string paymentGateway: description: | The name of the payment gateway instance. If null or left unassigned, the Account will use the Default Gateway. type: string returnedPaymentMethodType: description: | Container for a specific type of payment method on the customer account. For example, `creditcard`, `debitcard`, `creditcardreferencetransaction`, `ach`, etc. Each `returnedPaymentMethodType` array contains one or more payment methods of that payment method type. **Note:** The response could return more than one payment method type arrays. See **Response samples** as an example. items: $ref: '#/components/schemas/GETPaymentMethodResponseForAccount' title: Payment Method Type type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object - $ref: '#/components/schemas/CustomAccountPaymentMethod' GETPaymentMethodResponseForAccount: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/GETAccountPMAccountHolderInfo' accountVerificationService: description: | Displays the name of the service provider. For example, Plaid. type: string accountVerificationStatus: description: | Displays the status of the account. **Note:** - `Active` - Access token is active. - `Expired` - Access token has expired and must be linked again. - `Expiring` - Access token will expire in few days(7 days for Plaid) and must be linked again - `Inactive` - The end customer has revoked the account pemission. The end customer can login again and select the same method for the access token to be linked again. enum: - Active - Expired - Expiring - Inactive type: string bankIdentificationNumber: description: | The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. type: string createdBy: description: ID of the user who created this payment method. type: string createdOn: description: | The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string creditCardMaskNumber: description: | The masked credit card number, such as: ``` *********1112 ``` **Note:** This field is only returned for Credit Card Reference Transaction payment type. type: string creditCardType: description: | The type of the credit card or debit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways). **Note:** This field is only returned for the Credit Card and Debit Card payment types. type: string deviceSessionId: description: | The session ID of the user when the `PaymentMethod` was created or updated. type: string existingMandate: description: | Indicates whether the mandate is an existing mandate. enum: - 'Yes' - 'No' type: string id: description: | The payment method ID. type: string ipAddress: description: | The IP address of the user when the payment method was created or updated. type: string isDefault: description: | Indicates whether this payment method is the default payment method for the account. type: boolean lastFailedSaleTransactionDate: description: | The date of the last failed attempt to collect payment with this payment method. format: date-time type: string lastTransaction: description: ID of the last transaction of this payment method. type: string lastTransactionTime: description: The time when the last transaction of this payment method happened. format: date-time type: string mandateInfo: $ref: '#/components/schemas/POSTAccountPMMandateInfo' maxConsecutivePaymentFailures: description: | The number of allowable consecutive failures Zuora attempts with the payment method before stopping. type: integer numConsecutiveFailures: description: | The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. format: int32 type: integer paymentRetryWindow: description: | The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours. type: integer secondTokenId: description: | A gateway unique identifier that replaces sensitive payment method data. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. type: string status: description: | The status of the payment method. enum: - Active - Closed - Scrubbed type: string tokenId: description: | A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. type: string totalNumberOfErrorPayments: description: | The number of error payments that used this payment method. format: int32 type: integer totalNumberOfProcessedPayments: description: | The number of successful payments that used this payment method. format: int32 type: integer type: description: | The type of the payment method. type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay updatedBy: description: ID of the user who made the last update to this payment method. type: string updatedOn: description: | The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string useDefaultRetryRule: description: | Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings. type: boolean type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFieldsForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransferForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseACHForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCardForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponsePayPalForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePayForAccount' - $ref: '#/components/schemas/GETPaymentMethodResponseApplePayForAccount' CustomAccountPaymentMethod: additionalProperties: description: | Container for 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. **Note:** The response could return more than one custom payment methods. title: Custom Payment Method type: object description: | Container for 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. **Note:** The response could return more than one custom payment methods. title: CustomPaymentMethod type: object GETAccountPMAccountHolderInfo: description: | The account holder information. properties: accountHolderName: description: | The full name of the account holder. maxLength: 60 type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. type: string country: description: | The country where the account holder stays. When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see View countries or regions. Internationalization is not supported for the API field value. type: string nullable: true email: description: | The email address of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string title: accountHolderInfo type: object POSTAccountPMMandateInfo: description: | The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mandate fields are common to all supported payment methods: * `mandateId` * `mandateReason` * `mandateStatus` The following mandate fields are specific to the ACH and Bank Transfer payment methods: * `mandateReceivedStatus` * `existingMandateStatus` * `mandateCreationDate` * `mandateUpdateDate` The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods: * `mitTransactionId` * `mitProfileAgreedOn` * `mitConsentAgreementRef` * `mitConsentAgreementSrc` * `mitProfileType` * `mitProfileAction` properties: existingMandateStatus: description: | Indicates whether the mandate is an existing mandate. enum: - 'Yes' - 'No' type: string mandateCreationDate: description: | The date on which the mandate was created. format: date type: string mandateId: description: | The mandate ID. type: string mandateReason: description: | The reason of the mandate from the gateway side. type: string mandateReceivedStatus: description: | Indicates whether the mandate is received from the gateway enum: - 'Yes' - 'No' type: string mandateStatus: description: | The status of the mandate from the gateway side. type: string mandateUpdateDate: description: | The date on which the mandate was updated. format: date type: string mitConsentAgreementRef: description: | Reference for the consent agreement that you have established with the customer. type: string mitConsentAgreementSrc: description: | Required if you set the `mitProfileAction` field. Specify how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field. enum: - External type: string mitProfileAction: description: | Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the `status` field to `Active`. * `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. * `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field. enum: - Activate - Persist type: string mitProfileAgreedOn: description: | The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`. format: date type: string mitProfileType: description: | Indicates the type of the stored credential profile. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field. type: string mitTransactionId: description: | Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`. maxLength: 128 type: string title: mandateInfo type: object PaymentMethodObjectCustomFieldsForAccount: additionalProperties: description: | Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a payment method object. title: paymentMethodFieldsCustom type: object GETPaymentMethodResponseBankTransferForAccount: properties: IBAN: description: | The International Bank Account Number used to create the SEPA payment method. The value is masked. type: string accountNumber: description: | The number of the customer's bank account and it is masked. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string bankTransferType: description: | The type of the Bank Transfer payment method. For example, `SEPA`. type: string branchCode: description: | The branch code of the bank used for Direct Debit. type: string businessIdentificationCode: description: | The BIC code used for SEPA. The value is masked. type: string identityNumber: description: | The identity number of the account holder or the cardholder. type: string type: object GETPaymentMethodResponseACHForAccount: properties: bankABACode: description: | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. type: string bankAccountName: description: | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`. type: string type: object GETPaymentMethodResponseCreditCardForAccount: properties: cardNumber: description: | The masked credit card number. When `cardNumber` is `null`, the following fields will not be returned: - `expirationMonth` - `expirationYear` - `accountHolderInfo` type: string expirationMonth: description: | One or two digits expiration month (1-12). type: integer expirationYear: description: | Four-digit expiration year. type: integer securityCode: description: | The CVV or CVV2 security code for the credit card or debit card. Only required if changing expirationMonth, expirationYear, or cardHolderName. To ensure PCI compliance, this value isn''t stored and can''t be queried. type: string type: object GETPaymentMethodResponsePayPalForAccount: properties: BAID: description: | ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. type: string email: description: | Email address associated with the PayPal payment method. type: string preapprovalKey: description: | The PayPal preapproval key. type: string type: object GETPaymentMethodResponseGooglePayForAccount: properties: googleBIN: description: | This field is only available for Google Pay payment methods. type: string googleCardNumber: description: | This field is only available for Google Pay payment methods. type: string googleCardType: description: | This field is only available for Google Pay payment methods. For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. type: string googleExpiryDate: description: | This field is only available for Google Pay payment methods. type: string googleGatewayToken: description: | This field is only available for Google Pay payment methods. type: string type: object GETPaymentMethodResponseApplePayForAccount: properties: appleBIN: description: | This field is only available for Apple Pay payment methods. type: string appleCardNumber: description: | This field is only available for Apple Pay payment methods. type: string appleCardType: description: | This field is only available for Apple Pay payment methods. For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. type: string appleExpiryDate: description: | This field is only available for Apple Pay payment methods. type: string appleGatewayToken: description: | This field is only available for Apple Pay payment methods. type: string type: object GetCascadingPaymentMethodsConfigurationResponse: properties: consent: type: boolean description: | `true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. priorities: type: array description: | Container for the priority configuration of payment methods. items: type: object properties: paymentMethodId: type: string description: | The ID of a payment method. nullable: true order: type: integer minimum: 1 description: | The order of the payment method in the priority list. For example, `1` indicates the payment method is the first one in the priority list, and `2` indicates it is the second. The first payment method in the priority list is the default payment method of the customer account. title: priority success: type: boolean description: | Indicates whether the call succeeded. type: object PutCascadingPaymentMethodsConfigurationRequest: properties: consent: type: boolean description: | `true` indicates that you have collected consent from your customer to use the Cascading Payment Method feature. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. The `priorities` field can be specified only if `consent` is `true`. priorities: type: array description: | Container for the priority configuration of payment methods. You can add up to three payment methods to this container. For more information, see Cascade payment methods. `priorities` is required if `consent` is `true`. items: type: object properties: paymentMethodId: type: string description: | The ID of a payment method. order: type: integer minimum: 1 description: | The order of the payment method in the priority list. For example, `1` indicates the payment method is the first one in the priority list, and `2` indicates it is the second. The first payment method in the priority list will be the default payment method of the customer account. required: - paymentMethodId - order title: priority type: object example: consent: true priorities: - paymentMethodId: 2c92c0f95be68649015bf14e001f2760 order: 1 - paymentMethodId: 2c92c0f95be68649015bf14e001f2761 order: 2 - paymentMethodId: 2c92c0f95be68649015bf14e001f2762 order: 3 GETAccountSummaryType: properties: basicInfo: $ref: '#/components/schemas/GETAccountSummaryTypeBasicInfo' billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' invoices: description: | Container for invoices. Only returns the last 6 invoices. items: $ref: '#/components/schemas/GETAccountSummaryInvoiceType' type: array payments: description: | Container for payments. Only returns the last 6 payments. items: $ref: '#/components/schemas/GETAccountSummaryPaymentType' type: array shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' subscriptions: description: | Container for subscriptions. items: $ref: '#/components/schemas/GETAccountSummarySubscriptionType' type: array success: description: | Returns `true` if the request was processed successfully. type: boolean taxInfo: description: | Container for tax exempt information, used to establish the tax exempt status of a customer account. properties: VATId: description: | EU Value Added Tax ID. type: string companyCode: description: | Unique code that identifies a company account in Avalara. type: string exemptCertificateId: description: | ID of the customer tax exemption certificate. type: string exemptCertificateType: description: | Type of tax exemption certificate that the customer holds. type: string exemptDescription: description: | Description of the tax exemption certificate that the customer holds. type: string exemptEffectiveDate: description: | Date when the customer tax exemption starts. format: date type: string exemptEntityUseCode: description: | A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details. maxLength: 64 type: string exemptExpirationDate: description: | Date when the customer tax exemption expires. format: date type: string exemptIssuingJurisdiction: description: | Jurisdiction in which the customer tax exemption certificate was issued. type: string exemptStatus: description: | Status of the account tax exemption. type: string type: object usage: description: | Container for usage data. Only returns the last 6 months of usage. **Note:** If the Active Rating feature is enabled, no usage data is returned in the response body field. items: $ref: '#/components/schemas/GETAccountSummaryUsageType' type: array type: object GETAccountSummaryTypeBasicInfo: allOf: - properties: accountNumber: description: | Account number. type: string additionalEmailAddresses: description: | A list of additional email addresses to receive email notifications. items: type: string type: array autoPay: description: | Whether future payments are automatically collected when they are due during a payment run. type: boolean balance: description: | Current outstanding balance. format: decimal type: string batch: description: | The alias name given to a batch. A string of 50 characters or less. type: string billCycleDay: description: | Billing cycle day (BCD), the day of the month when a bill run generates invoices for the account. type: string currency: description: | A currency as defined in Billing Settings in the Zuora UI. type: string defaultPaymentMethod: description: | Information of the default payment method for the account. properties: creditCardExpirationMonth: description: | Two-digit numeric card expiration month as `mm`. type: string creditCardExpirationYear: description: | Four-digit card expiration year as `yyyy`. type: string creditCardNumber: description: | Credit card number, 16 characters or less, displayed in masked format (e.g., ************1234). type: string creditCardType: description: | The type of the credit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Methods](https://knowledgecenter.zuora.com/Zuora_Central/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods). type: string id: description: | ID of the default payment method associated with this account. type: string paymentMethodType: description: | Type of the payment method. For non-Credit-Card payment methods, only the `id` and `paymentMethodType` fields are returned. type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - BankTransfer - PayPal - AdyenApplePay - AdyenGooglePay - GooglePay type: object id: description: | Account ID. type: string invoiceDeliveryPrefsEmail: description: | Whether the customer wants to receive invoices through email. type: boolean invoiceDeliveryPrefsPrint: description: | Whether the customer wants to receive printed invoices, such as through postal mail. type: boolean lastInvoiceDate: description: | Date of the most recent invoice for the account; null if no invoice has ever been generated. format: date type: string lastMetricsUpdate: description: | The date and time when account metrics are last updated, if the account is a partner account. **Note**: - This field is available only if you have the Reseller Account feature enabled. - If you have the Reseller Account feature enabled, and set the `partnerAccount` field to `false` for an account, the value of the `lastMetricsUpdate` field is automatically set to `null` in the response. - If you ever set the `partnerAccount` field to `true` for an account, the value of `lastMetricsUpdate` field is the time when the account metrics are last updated. format: date-time type: string lastPaymentAmount: description: | Amount of the most recent payment collected for the account; null if no payment has ever been collected. format: decimal type: string lastPaymentDate: description: | Date of the most recent payment collected for the account. Null if no payment has ever been collected. format: date type: string name: description: | Account name. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string partnerAccount: description: | Whether the customer account is a partner, distributor, or reseller. **Note**: This field is available only if you have the Reseller Account feature enabled. type: boolean paymentMethodCascadingConsent: description: | `true` indicates the consent from your customer to use the Cascading Payment Method feature was collected. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. type: boolean purchaseOrderNumber: description: The purchase order number provided by your customer for services, products, or both purchased. type: string status: description: | Account status; possible values are: `Active`, `Draft`, `Canceled`. type: string tags: description: '' type: string type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' description: | Container for basic information about the account. title: basicInfo GETAccountSummaryTypeBillToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. ' type: string nullable: true fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string id: description: | Contact ID. type: string lastName: description: | Last name, 100 characters or less. type: string state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for bill-to contact information. **Notes**: - If the bill-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the bill-to contact on the subscription, see Overview of Flexible Billing Attributes. - If the bill-to contact is not specified on the subscription, the bill-to contact on the invoice owner account will be populated in this field. title: Contact GETAccountSummaryInvoiceType: properties: amount: description: | Invoice amount before adjustments, discounts, and similar items. type: number balance: description: | Balance due on the invoice. format: decimal type: string dueDate: description: | Due date as `yyyy-mm-dd`. format: date type: string id: description: | Invoice ID. type: string invoiceDate: description: | Invoice date as `yyyy-mm-dd`. format: date type: string invoiceNumber: description: | Invoice number. type: string status: description: | Invoice status - not the payment status of the invoice, just the status of the invoice itself. Possible values are: `Posted`, `Draft`, `Canceled`, `Error`. type: string title: invoices type: object GETAccountSummaryPaymentType: properties: effectiveDate: description: | Effective date as `yyyy-mm-dd`. format: date type: string id: description: | Payment ID. type: string paidInvoices: description: | Container for paid invoices for this subscription. items: $ref: '#/components/schemas/GETAccountSummaryPaymentInvoiceType' type: array paymentNumber: description: | Payment number. type: string paymentType: description: | Payment type; possible values are: `External`, `Electronic`. type: string status: description: | Payment status. Possible values are: `Draft`, `Processing`, `Processed`, `Error`, `Voided`, `Canceled`, `Posted`. type: string title: payments type: object GetAccountSummaryTypeShipToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. ' type: string nullable: true fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string id: description: | Contact ID. type: string lastName: description: | Last name, 100 characters or less. type: string state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for ship-to contact information. **Notes**: - If the ship-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the ship-to contact on the subscription, see Overview of Flexible Billing Attributes. - If the ship-to contact is not specified on the subscription, the ship-to contact on the subscription owner account will be populated in this field. title: Contact GETAccountSummaryTypeSoldToContact: allOf: - properties: address1: description: | First address line, 255 characters or less. type: string address2: description: | Second address line, 255 characters or less. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | City, 40 characters or less. type: string country: description: | Full country name. This field does not contain the ISO-standard abbreviation of the country name. type: string nullable: true county: description: 'County; 32 characters or less. Zuora Tax uses this information to calculate county taxation. ' type: string nullable: true fax: description: | Fax phone number, 40 characters or less. type: string firstName: description: | First name, 100 characters or less. type: string id: description: | Contact ID. type: string lastName: description: | Last name, 100 characters or less. type: string state: description: | Full state name. This field does not contain the ISO-standard abbreviation of the state name. type: string taxRegion: description: | A region string, defined in your Zuora tax rules. type: string workEmail: description: | Work email address, 80 characters or less. type: string workPhone: description: | Work phone number, 40 characters or less. type: string zipCode: description: | Zip code, 20 characters or less. type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' description: | Container for sold-to contact information. **Notes**: - If the sold-to contact is specified on the subscription, its value is populated in this field. For more information about how to specify the sold-to contact on the subscription, see Overview of Flexible Billing Attributes. - If the sold-to contact is not specified on the subscription, the sold-to contact on the subscription owner account will be populated in this field. title: Contact GETAccountSummarySubscriptionType: allOf: - properties: autoRenew: description: | If `true`, auto-renew is enabled. If `false`, auto-renew is disabled. type: boolean id: description: | Subscription ID. type: string initialTerm: description: | Duration of the initial subscription term in whole months. type: string ratePlans: description: | Container for rate plans for this subscription. items: $ref: '#/components/schemas/GETAccountSummarySubscriptionRatePlanType' type: array renewalTerm: description: | Duration of the renewal term in whole months. type: string status: description: | Subscription status; possible values are: `Draft`, `PendingActivation`, `PendingAcceptance`, `Active`, `Cancelled`, `Expired`. type: string subscriptionNumber: description: | Subscription Number. type: string subscriptionStartDate: description: | Subscription start date. format: date type: string termEndDate: description: | End date of the subscription term. If the subscription is evergreen, this is either null or equal to the cancellation date, as appropriate. format: date type: string termStartDate: description: | Start date of the subscription term. If this is a renewal subscription, this date is different than the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' title: subscriptions GETAccountSummaryUsageType: properties: quantity: description: | Number of units used. format: decimal type: string startDate: description: | The start date of a usage period as `yyyy-mm`. Zuora uses this field value to determine the usage date. format: date type: string unitOfMeasure: description: | Unit by which consumption is measured, as configured in the Billing Settings section of the web-based UI. type: string title: usage type: object GETAccountSummarySubscriptionRatePlanType: properties: productId: description: | Product ID. type: string productName: description: | Product name. type: string productRatePlanId: description: | Product Rate Plan ID. type: string productSku: description: '' type: string ratePlanName: description: | Rate plan name. type: string title: ratePlans type: object GETAccountSummaryPaymentInvoiceType: properties: appliedPaymentAmount: description: | Amount of payment applied to the invoice. format: decimal type: string invoiceId: description: | Invoice ID. type: string invoiceNumber: description: | Invoice number. type: string title: paidInvoices type: object POSTContactType: allOf: - properties: accountId: description: | The ID of the account associated with the contact. **Note**: When creating a contact, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string accountNumber: description: | The number of the customer account associated with the contact. **Note**: When creating a contact, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string address1: description: | The first line of the contact's address, which is often a street address or business name. maxLength: 255 type: string address2: description: | The second line of the contact's address. maxLength: 255 type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | The city of the contact's address. maxLength: 40 type: string contactDescription: description: | A description for the contact. maxLength: 100 type: string country: description: | The country of the contact's address. Either a full name or an ISO code is supported. maxLength: 64 type: string county: description: | The county. May optionally be used by Zuora Tax to calculate county tax. maxLength: 32 type: string fax: description: | The contact's fax number. maxLength: 40 type: string firstName: description: | The contact's first name. maxLength: 100 type: string homePhone: description: | The contact's home phone number. maxLength: 40 type: string lastName: description: | The contact's last name. maxLength: 100 type: string mobilePhone: description: | The mobile phone number of the contact. maxLength: 100 type: string nickname: description: | A nickname for the contact. maxLength: 100 type: string otherPhone: description: | An additional phone number for the contact. maxLength: 40 type: string otherPhoneType: description: | The type of the additional phone number. enum: - Work - Mobile - Home - Other type: string personalEmail: description: | The contact's personal email address. maxLength: 80 type: string format: email state: description: | The state or province of the contact's address. Either a full name or an abbreviation code is supported. maxLength: 40 type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. maxLength: 32 type: string workEmail: description: | The contact's business email address. maxLength: 80 type: string workPhone: description: | The contact's business phone number. maxLength: 40 type: string zipCode: description: | The zip code for the contact's address. maxLength: 20 type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactObjectCustomFields' example: accountId: 6e767220676e6e61206776652075207570 accountNumber: A00000001 address1: 314, Bongora address2: near Tech City city: GHY contactDescription: This is a description for the contact country: India fax: '6174' firstName: Kuhi homePhone: '1234123' lastName: Das mobilePhone: '123213' nickname: Dorimi otherPhone: '2314213' otherPhoneType: Work personalEmail: kuhiroll@example.com state: Assam zipCode: '123456' ContactResponse: allOf: - properties: accountId: description: | The ID of the account associated with the contact. type: string accountNumber: description: | The number of the customer account associated with the contact. type: string address1: description: | The first line of the contact's address, which is often a street address or business name. maxLength: 255 type: string address2: description: | The second line of the contact's address. maxLength: 255 type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | The city of the contact's address. maxLength: 40 type: string contactDescription: description: | A description for the contact. maxLength: 100 type: string country: description: | The full country name of the contact's address. maxLength: 64 type: string county: description: | The county. May optionally be used by Zuora Tax to calculate county tax. maxLength: 32 type: string fax: description: | The contact's fax number. maxLength: 40 type: string firstName: description: | The contact's first name. maxLength: 100 type: string homePhone: description: | The contact's home phone number. maxLength: 40 type: string lastName: description: | The contact's last name. maxLength: 100 type: string mobilePhone: description: | The mobile phone number of the contact. maxLength: 100 type: string nickname: description: | A nickname for the contact. maxLength: 100 type: string otherPhone: description: | An additional phone number for the contact. maxLength: 40 type: string otherPhoneType: description: | The type of the additional phone number. enum: - Work - Mobile - Home - Other type: string personalEmail: description: | The contact's personal email address. maxLength: 80 type: string state: description: | The full state or province name of the contact's address. maxLength: 40 type: string success: description: | Returns `true` if the request was processed successfully. type: boolean taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. maxLength: 32 type: string workEmail: description: | The contact's business email address. maxLength: 80 type: string workPhone: description: | The contact's business phone number. maxLength: 40 type: string zipCode: description: | The zip code for the contact's address. maxLength: 20 type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' PUTContactType: allOf: - properties: address1: description: | The first line of the contact's address, which is often a street address or business name. maxLength: 255 type: string address2: description: | The second line of the contact's address. maxLength: 255 type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | The city of the contact's address. maxLength: 40 type: string contactDescription: description: | A description for the contact. maxLength: 100 type: string country: description: | The country of the contact's address. Either a full name or an ISO code is supported. maxLength: 64 type: string county: description: | The county. May optionally be used by Zuora Tax to calculate county tax. maxLength: 32 type: string fax: description: | The contact's fax number. maxLength: 40 type: string firstName: description: | The contact's first name. maxLength: 100 type: string homePhone: description: | The contact's home phone number. maxLength: 40 type: string lastName: description: | The contact's last name. maxLength: 100 type: string mobilePhone: description: | The mobile phone number of the contact. maxLength: 100 type: string nickname: description: | A nickname for the contact. maxLength: 100 type: string otherPhone: description: | An additional phone number for the contact. maxLength: 40 type: string otherPhoneType: description: | The type of the additional phone number. enum: - Work - Mobile - Home - Other type: string personalEmail: description: | The contact's personal email address. maxLength: 80 type: string state: description: | The state or province of the contact's address. Either a full name or an abbreviation code is supported. maxLength: 40 type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. maxLength: 32 type: string workEmail: description: | The contact's business email address. maxLength: 80 type: string workPhone: description: | The contact's business phone number. maxLength: 40 type: string zipCode: description: | The zip code for the contact's address. maxLength: 20 type: string type: object - $ref: '#/components/schemas/ContactObjectCustomFields' example: address1: new Address city: Mumbai contactDescription: This is the new Description mobilePhone: 123213 zipCode: 123134 PUTTransferContact: type: object properties: destinationAccountKey: description: | The ID or number of the destination account. type: string example: destinationAccountKey: A00000135 GETContactSnapshotResponse: allOf: - properties: address1: description: | The first line for the address of the contact, which is often a street address or business name. type: string address2: description: | The second line for the address of the contact, which is mostly the locality. type: string asBillTo: description: | Indicates whether the contact can be specified as a bill-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asShipTo: description: | Indicates whether the contact can be specified as a ship-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean asSoldTo: description: | Indicates whether the contact can be specified as a sold-to contact. This field is available only if you have turned on the Ship To Contact feature. You can turn on the feature through the self-service interface for Feature Management. type: boolean city: description: | The city for the address of the contact. type: string contactId: description: | The Zuora ID of the contact who the snapshot belongs to. type: string country: description: | The country for the address of the contact. type: string nullable: true county: description: | The county for the address of the contact. The field value might optionally be used by Zuora Tax to calculate county tax. type: string description: description: | A description of the contact. type: string fax: description: | The fax number of the contact. format: number type: string firstName: description: | The first name of the contact. type: string homePhone: description: | The home phone number of the contact. format: number type: string id: description: | The unique ID of the contact snapshot. type: string lastName: description: | The last name of the contact. type: string mobilePhone: description: | The mobile phone number of the contact. format: number type: string nickname: description: | A nickname for the contact. type: string otherPhone: description: | An additional phone number for the contact. type: string otherPhoneType: description: | The type of the additional phone number. enum: - Work - Mobile - Home - Other type: string personalEmail: description: | The personal email address of the contact. type: string maxLength: 80 postalCode: description: | The postal code for the address of the contact. format: number type: string state: description: | The state or province for the address of the contact. type: string taxRegion: description: | If using Zuora Tax rules. type: string workEmail: description: | The business email address of the contact. type: string workPhone: description: | The business email address of the contact. format: number type: string type: object - $ref: '#/components/schemas/ContactSnapshotObjectCustomFields' ContactSnapshotObjectCustomFields: additionalProperties: description: | Custom fields of the Contact Snapshot object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. For more information, see Manage custom fields. description: | Container for custom fields of a Contact Snapshot object. title: contactSnapshotFieldsCustom type: object POSTSubscriptionPreviewType: allOf: - properties: accountKey: description: | Customer account number or ID. You must specify the account information either in this field or in the `previewAccountInfo` field with the following conditions: * If you already have a customer account, specify the account number or ID in this field. * If you do not have a customer account, provide account information in the `previewAccountInfo` field. type: string contractEffectiveDate: description: | Effective contract date for this subscription, as yyyy-mm-dd. format: date type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. Default value is dependent on the value of other fields. See **Notes** section for more details. format: date type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string includeExistingDraftDocItems: description: | Specifies whether to include draft invoice items in subscription previews. Values are: * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean initialTerm: description: | Duration of the first term of the subscription, in whole months. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored. format: int64 type: integer initialTermPeriodType: description: |+ The period type of the initial term. Supported values are: * `Month` * `Year` * `Day` * `Week` The default period type is `Month`. type: string invoiceOwnerAccountKey: description: | Invoice owner account number or ID. **Note:** 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/). type: string notes: description: The notes for the subscription. maxLength: 1000 type: string previewAccountInfo: $ref: '#/components/schemas/POSTSubscriptionPreviewTypePreviewAccountInfo' previewType: description: | The type of preview you will receive. **Note**: If your API minor version is earlier than `206.0` or you specify the `Zuora-Version` header for this request to `206.0` or earlier, the following values are supported for the `previewType` field: - `InvoiceItem` (default) - `ChargeMetrics` - `InvoiceItemChargeMetrics` enum: - LegalDoc - ChargeMetrics - LegalDocChargeMetrics type: string default: LegalDoc serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd. Default value is dependent on the value of other fields. See **Notes** section for more details. format: date type: string subscribeToRatePlans: description: | Container for one or more rate plans for this subscription. items: $ref: '#/components/schemas/POSTSrpCreateType' type: array targetDate: description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. **Note:** This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string termStartDate: description: | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string required: - termType - contractEffectiveDate - subscribeToRatePlans type: object - $ref: '#/components/schemas/SubscriptionObjectCustomFields' example: accountKey: 8ad09be48db5aba7018db604776d4854 contractEffectiveDate: '2024-07-01' termType: TERMED initialTerm: 12 subscribeToRatePlans: - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4 POSTSubscriptionPreviewResponseType: properties: chargeMetrics: description: | Container for charge metrics. properties: dmrr: description: | Change in monthly recurring revenue. type: string dtcv: description: | Change in total contract value. type: string mrr: description: | Monthly recurring revenue. type: string number: description: | The charge number of the subscription. Only available for update subscription. type: string originRatePlanId: description: | The origin rate plan ID. Only available for update subscription. type: string originalId: description: | The original rate plan charge ID. Only available for update subscription. type: string productRatePlanChargeId: description: | The product rate plan charge ID. type: string productRatePlanId: description: | The product rate plan ID. type: string tcv: description: | Total contract value. type: string type: object contractedMrr: description: | Monthly recurring revenue of the subscription. type: number creditMemo: description: | Container for credit memos. **Note:** This container is only available if you are on the latest Zuora API version or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version), and 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. properties: amount: description: Credit memo amount. format: double type: number amountWithoutTax: description: Credit memo amount minus tax. format: double type: number creditMemoItems: description: '' items: $ref: '#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType' type: array taxAmount: description: Tax amount on the credit memo. format: double type: number type: object documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string invoice: description: | Container for invoices. **Note:** This field is only available if you set the Zuora REST API minor version to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version) in the request header. Also, the response structure is changed and the following invoice related response fields are moved to this **invoice** container: * amount * amountWithoutTax * taxAmount * invoiceItems properties: amount: description: Invoice amount. type: number amountWithoutTax: description: | Invoice amount minus tax. type: number invoiceItems: description: | Container for invoice items. items: $ref: '#/components/schemas/POSTSubscriptionPreviewInvoiceItemsType' type: array targetDate: description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. **Note:** This field is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header. type: string taxAmount: description: | The tax amount of the invoice. type: number type: object success: description: | Returns `true` if the request was processed successfully. type: boolean targetDate: description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. **Note:** This field is only available if you set the Zuora REST API minor version to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version) in the request header. format: date type: string taxAmount: description: | Tax amount on the invoice. type: number totalContractedValue: description: | Total contracted value of the subscription. type: number type: object POSTSubscriptionPreviewCreditMemoItemsType: properties: amountWithoutTax: description: | The credit memo item amount excluding tax. format: double type: number chargeAmount: description: | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax format: double type: number chargeDescription: description: | Description of this credit memo item. type: string chargeName: description: | Name of this credit memo item. type: string productName: description: | Name of the product associated with this credit memo item. type: string productRatePlanChargeId: description: | ID of the product rate plan charge associated with this credit memo item. type: string quantity: description: | Quantity of the charge associated with this credit memo item. type: integer serviceEndDate: description: | End date of the service period for this credit memo item, as yyyy-mm-dd. format: date type: string serviceStartDate: description: | Service start date of this credit memo item, as yyyy-mm-dd. format: date type: string taxAmount: description: | The tax amount of the credit memo item. format: double type: number taxationItems: description: |- List of taxation items. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `315.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: description: Unit used to measure consumption. type: string title: creditMemoItems type: object POSTSubscriptionPreviewInvoiceItemsType: properties: chargeAmount: description: | The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive. type: number chargeDescription: description: | Description of the charge. type: string chargeName: description: | Name of the charge. type: string productName: description: | Name of the product associated with this item. type: string productRatePlanChargeId: description: | ID of the product rate plan charge. type: string quantity: description: | Quantity of this item. type: number serviceEndDate: description: | End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. format: date type: string serviceStartDate: description: | Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. format: date type: string taxAmount: description: | The tax amount of the invoice item. format: double type: number taxationItems: description: |- List of taxation items. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `315.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: description: '' type: string title: invoiceItems type: object POSTSubscriptionPreviewTaxationItemsType: properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. type: number jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the taxCode field. type: string name: description: | The name of the taxation item. type: string taxAmount: description: | The tax amount of the invoice item. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific invoice. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date when the tax is applied to the invoice. type: string taxRate: description: 'The tax rate applied to the invoice. ' type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | Enum:"Percentage" "FlatFee". The type of the tax rate applied to the invoice. enum: - Percentage - FlatFee type: string title: taxationItems type: object POSTSubscriptionPreviewTypePreviewAccountInfo: allOf: - properties: billCycleDay: description: | The account's bill cycle day (BCD), when bill runs generate invoices for the account. Specify any day of the month (`1`-`31`, where `31` = end-of-month), or `0` for auto-set. format: int64 type: integer billToContact: description: | Container for bill-to contact information of this account. properties: city: description: | The city of the bill-to address. The value should be 40 characters or less. type: string country: description: | The country of the bill-to address. The value must be a valid country name or abbreviation. **Note:** You must specify this field if you are using Zuora Tax for this account. type: string county: description: | The county of the bill-to address. The value should be 32 characters or less. type: string state: description: | The state of the bill-to address. The value must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. **Note:** You must specify this field if you are using Zuora Tax for this account and the country is `USA` or `Canada`. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. type: string zipCode: description: | The zip code of the bill-to address. The value should be 20 characters or less. type: string type: object currency: description: | A currency as defined in Billing Settings. type: string required: - billCycleDay - billToContact - currency type: object - $ref: '#/components/schemas/AccountObjectNSFields' - $ref: '#/components/schemas/AccountObjectCustomFields' description: | A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for subscription preview. You must specify the account information either in this field or in the `accountKey` field with the following conditions: * If you already have a customer account, specify the account number or ID in the accountKey field. * If you do not have a customer account, provide account information in this field. title: previewAccountInfo PreviewExistingSubscriptionRequest: description: | Preview the existing subscription by subscription ID or number. properties: previewStartDate: $ref: '#/components/schemas/PreviewStartDate' previewThroughDate: $ref: '#/components/schemas/PreviewThroughDate' quantityForUsageCharges: items: $ref: '#/components/schemas/QuantityForUsageCharges' type: array description: | Container for usage charges. type: object example: previewStartDate: previewStartDatePolicy: specificDate specificDate: '2024-01-01' previewThroughDate: previewThruDatePolicy: nextBillingPeriods nextBillingPeriods: '2' quantityForUsageCharges: - chargeId: 402880e78ccd1743018cce026efb002d quantity: 20 PreviewExistingSubscriptionResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: invoices: description: Container for invoices. items: $ref: '#/components/schemas/PreviewExistingSubscriptionResultInvoices' type: array creditMemos: description: | Container for credit memos. **Note**: This field is only available if you have the Invoice Settlement feature enabled. items: $ref: '#/components/schemas/PreviewExistingSubscriptionResultCreditMemos' type: array type: object PreviewExistingSubscriptionResultInvoices: properties: invoiceNumber: type: string description: | The invoice number. amount: type: number description: | Invoice amount. format: double amountWithoutTax: type: number description: | Invoice amount minus tax. format: double taxAmount: type: number description: | The tax amount of the invoice. format: double targetDate: format: date type: string description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. invoiceItems: items: $ref: '#/components/schemas/PreviewExistingSubscriptionInvoiceItemResult' type: array description: | The container for invoice items. status: type: string description: | The status of the invoice. enum: - Draft - Posted - null nullable: true isFromExistingInvoice: type: boolean description: | Indicates whether the invoice information is from an existing invoice. type: object PreviewExistingSubscriptionResultCreditMemos: properties: creditMemoNumber: type: string description: The credit memo number. amount: type: number description: Credit memo amount. format: double amountWithoutTax: type: number description: Credit memo amount minus tax. format: double taxAmount: type: number description: The tax amount of the credit memo. format: double targetDate: format: date type: string description: Date through which to calculate charges if a credit memo is generated, as yyyy-mm-dd. creditMemoItems: items: $ref: '#/components/schemas/PreviewExistingSubscriptionCreditMemoItemResult' type: array description: Container for credit memo items. status: type: string description: The status of the credit memo. nullable: true isFromExistingCreditMemo: type: boolean description: Indicates whether the credit memo information is from an existing credit memo. type: object PreviewExistingSubscriptionCreditMemoItemResult: properties: serviceStartDate: format: date type: string description: Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. serviceEndDate: format: date type: string description: End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. amountWithoutTax: type: number description: Credit memo amount minus tax. format: double taxAmount: type: number description: The tax amount of the credit memo item. format: double chargeDescription: type: string description: Description of the charge. chargeName: type: string description: Name of the charge. chargeNumber: description: Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription. type: string productName: type: string description: Name of the product. productRatePlanChargeId: type: string description: The ID of the product rate plan charge. processingType: type: string description: The processing type of the credit memo item. enum: - Charge - Discount - Tax unitPrice: type: number description: The unit price of the charge. format: double quantity: type: number description: The quantity of the charge. unitOfMeasure: type: string description: The unit of measure of the charge. nullable: true discountDetails: items: $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails' type: array description: Container for discount details. type: object PreviewExistingSubscriptionDiscountDetails: properties: discountChargeName: type: string description: The charge name of the discount. discountChargeNumber: type: string description: The charge number of the discount. discountRate: type: number description: The discount rate. type: object PreviewExistingSubscriptionInvoiceItemResult: properties: serviceStartDate: format: date type: string description: Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. serviceEndDate: format: date type: string description: End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. amountWithoutTax: type: number description: Invoice amount minus tax. format: double taxAmount: type: number description: The tax amount of the invoice item. format: double chargeDescription: type: string description: Description of the charge. chargeName: type: string description: Name of the charge. chargeNumber: description: Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription. type: string productName: type: string description: Name of the product. productRatePlanChargeId: type: string description: The ID of the product rate plan charge. processingType: type: string description: The processing type of the invoice item. enum: - Charge - Discount - Tax unitPrice: type: number description: The unit price of the charge. format: double quantity: type: number description: The quantity of the charge. unitOfMeasure: type: string description: The unit of measure of the charge. nullable: true discountDetails: items: $ref: '#/components/schemas/PreviewExistingSubscriptionDiscountDetails' type: array description: Container for discount details. type: object PreviewStartDate: description: | The start date of the preview. properties: previewStartDatePolicy: $ref: '#/components/schemas/PreviewStartDatePolicy' specificDate: description: | The specific date for the preview start date. Required if `previewStartDatePolicy` is `specificDate`. type: string type: object PreviewThroughDate: description: | The preview through date. properties: previewThruDatePolicy: $ref: '#/components/schemas/PreviewThruDatePolicy' nextBillingPeriods: description: | The number of billing periods to preview. Required if `previewThruDatePolicy` is `nextBillingPeriods`. type: number specificDate: description: | The specific date for the preview start date. Required if `previewThruDatePolicy` is `specificDate`. type: string type: object QuantityForUsageCharges: allOf: - properties: chargeId: description: | The ID of the subscription charge. type: string quantity: description: | The quantity of the subscription charge. type: number type: object PreviewThruDatePolicy: description: | The options on how the preview through date is calculated. - If you set this field to `nextBillingPeriods`, you must specify the number of billing periods to preview in the `nextBillingPeriods` field. - If you set this field to `endOfTerm`, the preview through date is the end date of the subscription term. - If you set this field to `specificDate`, you must specify a specific date in the `specificDate` field. The date must be in the format `yyyy-mm-dd`. enum: - nextBillingPeriods - endOfTerm - specificDate type: string PreviewStartDatePolicy: description: | The options on how the preview start date is calculated. - If you set this field to `startOfTerm`, the preview start date is the start date of the subscription term. - If you set this field to `today`, the preview start date is today. - If you set this field to `specificDate`, you must specify a specific date in the `specificDate` field. The date must be in the format `yyyy-mm-dd`. enum: - startOfTerm - today - specificDate type: string POSTSubscriptionType: allOf: - properties: accountKey: description: | Customer account number or ID type: string applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean autoRenew: default: false description: | If true, this subscription automatically renews at the end of the subscription term. This field is only required if the `termType` field is set to `TERMED`. type: boolean collect: default: true description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `196.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean contractEffectiveDate: description: | Effective contract date for this subscription, as yyyy-mm-dd format: date type: string creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. Default value is dependent on the value of other fields. See **Notes** section for more details. format: date type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string externallyManagedBy: description: | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. enum: - Amazon - Apple - Google - Roku type: string gatewayId: description: | The ID of the payment gateway instance. For example, `2c92c0f86078c4d5016091674bcc3e92`. If Payment Gateway Routing is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment. type: string initialTerm: description: | The length of the period for the first subscription term. If `termType` is `TERMED`, then this field is required, and the value must be greater than `0`. If `termType` is `EVERGREEN`, this field is ignored. format: int64 type: integer initialTermPeriodType: description: | The period type for the first subscription term. This field is used with the `InitialTerm` field to specify the initial subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string invoiceOwnerAccountKey: description: | Invoice owner account number or ID. **Note:** 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/). type: string invoiceSeparately: description: | Separates a single subscription from other subscriptions and invoices the charge independently. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. The default value is `false`. Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes. type: boolean lastBookingDate: description: |- The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date. format: date type: string notes: description: | The notes for the subscription. maxLength: 1000 type: string paymentMethodId: description: | The ID of the payment method used for the payment. type: string prepayment: description: | Indicates whether the subscription will consume the reserved payment amount of the customer account. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. type: boolean renewalSetting: description: | Specifies whether a termed subscription will remain termed or change to evergreen when it is renewed. Values: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` type: string renewalTerm: description: | The length of the period for the subscription renewal term. Default is `0`. format: int64 type: integer renewalTermPeriodType: description: | The period type for the subscription renewal term. This field is used with the `renewalTerm` field to specify the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string runBilling: default: true description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. type: boolean serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd. Default value is dependent on the value of other fields. See **Notes** section for more details. format: date type: string subscribeToRatePlans: description: | Container for one or more rate plans for this subscription. items: $ref: '#/components/schemas/POSTSrpCreateType' type: array subscriptionNumber: description: | Subscription Number. The value can be up to 1000 characters. If you do not specify a subscription number when creating a subscription, Zuora will generate a subscription number automatically. If the account is created successfully, the subscription number is returned in the `subscriptionNumber` response field. type: string targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note**: - This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string termStartDate: description: | The date on which the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string required: - accountKey - contractEffectiveDate - subscribeToRatePlans - termType - renewalTerm type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' example: accountKey: 8ad09be48db5aba7018db604776d4854 contractEffectiveDate: '2024-07-16' termType: TERMED initialTerm: 12 renewalTerm: 12 autoRenew: true subscribeToRatePlans: - productRatePlanId: 8ad081dd9096ef9501909b40bb4e74a4 POSTSubscriptionResponseType: properties: contractedMrr: description: | Monthly recurring revenue of the subscription. type: number creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoiceId: description: | Invoice ID, if an invoice is generated during the subscription process. type: string paidAmount: description: | Payment amount, if a payment is collected. type: number paymentId: description: | Payment ID, if a payment is collected. type: string subscriptionId: description: '' type: string subscriptionNumber: description: '' type: string success: description: | Returns `true` if the request was processed successfully. type: boolean totalContractedValue: description: | Total contracted value of the subscription. type: number type: object GETSubscriptionWrapper: properties: nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string subscriptions: description: | Array of subscriptions. items: $ref: '#/components/schemas/GETSubscriptionType' type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETSubscriptionType: allOf: - properties: accountId: description: '' type: string accountName: description: '' type: string accountNumber: description: '' type: string autoRenew: description: | If `true`, the subscription automatically renews at the end of the term. Default is `false`. type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: description: | The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`. type: string contractEffectiveDate: description: | Effective contract date for this subscription, as yyyy-mm-dd. format: date type: string contractedMrr: description: | Monthly recurring revenue of the subscription. type: number contractedNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number asOfDayGrossMrr: description: | Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day. type: number asOfDayNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day. type: number netTotalContractedValue: description: | Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number currency: description: | The currency of the subscription. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string currentTerm: description: | The length of the period for the current subscription term. format: int64 type: integer currentTermPeriodType: description: | The period type for the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. format: date type: string externallyManagedBy: description: | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. enum: - Amazon - Apple - Google - Roku type: string id: description: | Subscription ID. type: string initialTerm: description: | The length of the period for the first subscription term. format: int64 type: integer initialTermPeriodType: description: | The period type for the first subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string invoiceGroupNumber: description: | The number of the invoice group associated with the subscription. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true invoiceOwnerAccountId: description: '' type: string invoiceOwnerAccountName: description: '' type: string invoiceOwnerAccountNumber: description: '' type: string invoiceScheduleId: description: | The ID of the invoice schedule associated with the subscription. If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: integer invoiceSeparately: description: | Separates a single subscription from other subscriptions and creates an invoice for the subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. type: boolean invoiceTemplateId: description: | The ID of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string invoiceTemplateName: description: | The name of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body. type: string isLatestVersion: description: If `true`, the current subscription object is the latest version. type: boolean lastBookingDate: description: |- The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date. format: date type: string notes: description: | A string of up to 65,535 characters. type: string orderNumber: description: | The order number of the order in which the changes on the subscription are made. **Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentTerm: description: | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string ratePlans: description: | Container for rate plans. items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: description: | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. Values are: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` type: string renewalTerm: description: | The length of the period for the subscription renewal term. format: int64 type: integer renewalTermPeriodType: description: | The period type for the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string revision: description: | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions. type: string sequenceSetId: description: | The ID of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the subscription. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true sequenceSetName: description: | The name of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body. type: string serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: description: | Subscription status; possible values are: * `Draft` * `Pending Activation` * `Pending Acceptance` * `Active` * `Cancelled` * `Suspended` type: string statusHistory: description: | Container for status history. items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: description: | The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate. format: date type: string subscriptionNumber: description: '' type: string subscriptionStartDate: description: | Date the subscription becomes effective. format: date type: string termEndDate: description: | Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). format: date type: string termStartDate: description: | Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string scheduledCancelDate: description: The date when the subscription is scheduled to be canceled. format: date type: string scheduledSuspendDate: description: The date when the subscription is scheduled to be suspended. format: date type: string scheduledResumeDate: description: The date when the subscription is scheduled to be resumed. format: date type: string totalContractedValue: description: | Total contracted value of the subscription. type: number version: description: This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment. format: int64 type: integer type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' title: subscriptions GETSubscriptionRatePlanType: allOf: - properties: externallyManagedPlanId: description: | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. type: string id: description: | Rate plan ID. type: string lastChangeType: description: | The last amendment on the rate plan. **Note:** If a subscription is created through an order, this field is only available if multiple orders are created on the subscription. Possible Values: * `Add` * `Update` * `Remove` type: string productId: description: '' type: string productName: description: '' type: string productRatePlanId: description: '' type: string productSku: description: | The unique SKU for the product. type: string contractedMrr: description: | Monthly recurring revenue of the subscription rate plan exclusive of all the discounts applicable. type: number contractedNetMrr: description: | Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number asOfDayGrossMrr: description: | Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day. type: number asOfDayNetMrr: description: | Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day. type: number ratePlanCharges: description: | Container for one or more charges. items: $ref: '#/components/schemas/GETSubscriptionRatePlanChargesType' type: array ratePlanName: description: | Name of the rate plan. type: string subscriptionProductFeatures: description: |- Container for one or more features. Only available when the following settings are enabled: * The Entitlements feature in your tenant. * The Enable Feature Specification in Product and Subscriptions setting in Zuora Billing Settings items: $ref: '#/components/schemas/GETSubscriptionProductFeatureType' type: array type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: ratePlans GETSubscriptionStatusHistoryType: allOf: - properties: endDate: description: The effective end date of the status history. format: date type: string startDate: description: The effective start date of the status history. format: date type: string status: description: | The status of the subscription. Values are: * `Pending Activation` * `Pending Acceptance` * `Active` * `Cancelled` * `Suspended` * `OutOfTerm` type: string type: object title: statusHistory GETSubscriptionRatePlanChargesType: allOf: - properties: amendedByOrderOn: description: | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. type: string applyDiscountTo: description: | Specifies the type of charges a specific discount applies to. This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is null. Possible values: * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE` type: string applyToBillingPeriodPartially: description: | Allow the discount duration to be aligned with the billing period partially. **Note**: This field is only available if you have the [Enhanced Discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Build_products_and_prices/Basic_concepts_and_terms/B_Charge_Models/D_Manage_Enhanced_Discount) feature enabled. type: boolean billingDay: description: | Billing cycle day (BCD), which is when bill runs generate invoices for charges associated with the product rate plan charge or the account. Values: * `DefaultFromCustomer` * `SpecificDayofMonth(# of the month)` * `SubscriptionStartDay` * `ChargeTriggerDay` * `SpecificDayofWeek/dayofweek`: in which dayofweek is the day in the week you define your billing periods to start. In the response data, a day-of-the-month ordinal value (`first`-`31st`) appears in place of the hash sign above ("#"). If this value exceeds the number of days in a particular month, the last day of the month is used as the BCD. type: string billingPeriod: description: | Allows billing period to be overridden on the rate plan charge. type: string billingPeriodAlignment: description: | Possible values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` type: string billingTiming: description: | The billing timing for the charge. This field is only used if the `ratePlanChargeType` value is `Recurring`. Possible values are: * `In Advance` * `In Arrears` **Note:** 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/). type: string chargeFunction: description: | **Note**: This field is only available if you have the Prepaid with Drawdown or Minimum Commitment feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `141` or higher. Otherwise, an error occurs. This field defines what type of charge it is: * Standard: Normal charge with no Prepayment or Commitment or Drawdown. * Prepayment: For recurring charges. Unit or currency based prepaid charge. * CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. * Drawdown: For usage charges. Drawdown from prepaid funds. * DrawdownAndCreditCommitment: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds. * CreditCommitment: For usage charges. Credit to minimum commitment funds. enum: - Standard - Prepayment - CommitmentTrueUp - Drawdown - CreditCommitment - DrawdownAndCreditCommitment type: string commitmentType: description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `133` or higher. Otherwise, an error occurs. This field defines the type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. A minimum commitment(in-arrears) charge can only be `CURRENCY` type. For topup(recurring or one-time) charges, this field indicates what type of funds are created. * If UNIT, it will create a fund with given prepaidUom. * If CURRENCY, it will create a fund with the currency amount calculated in list price. For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges. enum: - UNIT - CURRENCY type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' chargeSegments: description: | This field is returned only if you have set the `charge-detail` query parameter to `all-segments`. Container for the charge information for all the charge segments. type: array items: $ref: '#/components/schemas/RatePlanChargeSegment' chargedThroughDate: description: | The date through which a customer has been billed for the charge. format: date type: string creditOption: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. To use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. The way to calculate credit. See [Credit Option](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge#Credit_Option) for more information. enum: - TimeBased - ConsumptionBased - FullCreditBack type: string currency: description: | Currency used by the account. For example, `USD` or `EUR`. type: string description: description: | Description of the rate plan charge. type: string discountAmount: description: | The amount of the discount. type: number discountApplyDetails: description: | Container for the application details about a discount rate plan charge. Only discount rate plan charges have values in this field. items: $ref: '#/components/schemas/DiscountApplyDetails' type: array discountClass: description: | The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied. For more information, see [Manage Discount Classes](https://knowledgecenter.zuora.com/BC_Subscription_Management/Product_Catalog/B_Charge_Models/Manage_Discount_Classes). type: string discountLevel: description: | The level of the discount. Values: `RatePlan`, `Subscription`, `Account`. type: string discountPercentage: description: | The amount of the discount as a percentage. type: number dmrc: description: | The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription. type: number done: description: | A value of `true` indicates that an invoice for a charge segment has been completed. A value of `false` indicates that an invoice has not been completed for the charge segment. type: boolean drawdownRate: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The [conversion rate](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge#UOM_Conversion) between Usage UOM and Drawdown UOM for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). Must be a positive number (>0). type: number drawdownUom: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. Unit of measurement for a [drawdown charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_drawdown_charge). type: string dtcv: description: | After an amendment or an AutomatedPriceChange event, `dtcv` displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types. type: number effectiveEndDate: description: | The effective end date of the rate plan charge. format: date type: string effectiveStartDate: description: | The effective start date of the rate plan charge. format: date type: string endDateCondition: description: | Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date. Values: * `Subscription_End` * `Fixed_Period` * `Specific_End_Date` * `One_Time` type: string estimatedStartDate: type: string format: date description: | The estimated start date of the pending charge in an active subscription. The value must be a date within the subscription term. The system will then automatically calculate the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. estimatedEndDate: type: string format: date description: | The estimated end date of the pending charge in an active subscription. The system automatically calculates the estimated end date for the pending charge. The estimated start and end dates are used to manage the estimated charge duration and forecast the revenue for the pending charge. **Note:** This field is available only when the Pending Subscription Processing feature is turned on. excludeItemBillingFromRevenueAccounting: description: | The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean excludeItemBookingFromRevenueAccounting: description: | The flag to exclude rate plan charges from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean id: description: | Rate plan charge ID. type: string includedUnits: description: | Specifies the number of units in the base set of units. type: number invoiceScheduleId: description: | The ID of the invoice schedule associated with the rate plan charge on the subscription. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string isAllocationEligible: description: | This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean isDimensionalPrice: description: | **Note**: This field is only available when the Dynamic Pricing feature is enabled. Indicates whether the charge uses dimensional pricing. When set to true, this charge enables dynamic pricing. type: boolean isPrepaid: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. Values: `true` or `false`. type: boolean isPriceNegotiated: description: | **Note**: This field is only available when the Negotiated Price Table feature is enabled. Indicates whether the charge uses negotiated pricing. When set to true, this charge defines a negotiated price table. type: boolean isRollover: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The value is either "True" or "False". It determines whether the rollover fields are needed. type: boolean isStackedDiscount: description: | **Note**: This field is only applicable to the Discount - Percentage charge model. To use this field, you must set the `X-Zuora-WSDL-Version` request header to 130 or higher. Otherwise, an error occurs. This field indicates whether the discount is to be calculated as stacked discount. Possible values are as follows: - `True`: This is a stacked discount, which should be calculated by stacking with other discounts. - `False`: This is not a stacked discount, which should be calculated in sequence with other discounts. For more information, see [Stacked discounts](https://knowledgecenter.zuora.com/Zuora_Billing/Products/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models). type: boolean isUnbilled: description: | This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean listPriceBase: description: | List price base; possible values are: * `Per_Billing_Period` * `Per_Month` * `Per_Week` * `Per_Year` * `Per_Specific_Months` type: string model: description: | Charge model; possible values are: * `FlatFee` * `PerUnit` * `Overage` * `Volume` * `Tiered` * `TieredWithOverage` * `DiscountFixedAmount` * `DiscountPercentage` * `MultiAttributePricing` * `PreratedPerUnit` * `PreratedPricing` * `HighWatermarkVolumePricing` * `HighWatermarkTieredPricing` * `Delivery` type: string mrr: description: | Monthly recurring revenue of the rate plan charge. type: number name: description: | Charge name. type: string number: description: | Charge number. type: string numberOfDeliveries: description: | Number of deliveries in the billing period for the charge segment. The `numberOfDeliveries` is used for the Delivery Pricing charge model only. type: number numberOfPeriods: description: | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. format: int64 type: integer originalChargeId: description: | The original ID of the rate plan charge. type: string originalListPrice: description: | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. **Note:** This field applies to the following charges in a subscription created through an order: - `oneTimeFlatFee` - `oneTimePerUnit` - `recurringFlatFee` - `recurringPerUnit` - `usageFlatFee` - `usagePerUnit` - `usageOverage` - `usageTieredWithOverage` type: number originalOrderDate: description: | The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. format: date type: string overageCalculationOption: description: | Determines when to calculate overage charges. type: string overagePrice: description: | The price for units over the allowed amount. type: number overageUnusedUnitsCreditOption: description: | Determines whether to credit the customer with unused units of usage. type: string prepaidOperationType: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. enum: - topup - drawdown type: string prepaidQuantity: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The number of units included in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). Must be a positive number (>0). type: number prepaidTotalQuantity: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). type: number prepaidUom: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. Unit of measurement for a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). type: string price: description: | The price associated with the rate plan charge expressed as a decimal. type: number pricingAttributes: description: | Container for pricing attributes that provide additional context for dynamic pricing. This field includes all the dynamic pricing attributes and values associated with this charge, except for the pricing attributes mapped to Zuora Usage object fields. **Note:** You must enable the Dynamic Pricing feature to access this field. The Dynamic Pricing 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. If you want to join this early adopter program, submit a request at Zuora Global Support. type: object additionalProperties: true salesPrice: description: | The sales price associated with the rate plan charge expressed as a decimal. **Notes**: - This field is only available to subscriptions that are created through orders and exist after 2023-01-10. - This field applies to the following charge models, and the values vary with the charge models: - Flat fee: the value equals the value of the `price` field. - Per unit: the value equals `price` multiplied by `quantity`. - Fixed amount discount: the value equals the value of the `discountAmount` field. - Volume: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. - Tiered: The calculation of the tier price is dependent on whether the price format is the flat fee or per unit. type: number priceChangeOption: description: | When the following is true: 1. AutomatedPriceChange setting is on 2. Charge type is not one-time 3. Charge model is not discount percentage Then an automatic price change can have a value for when a termed subscription is renewed. Values (one of the following): * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` type: string priceIncreasePercentage: description: | A planned future price increase amount as a percentage. type: number pricingSummary: description: | Concise description of rate plan charge model. type: string processedThroughDate: description: | The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. format: date type: string productCategory: description: | This is used to maintain the product category. **Note**: This field is only available if you have the Additional Revenue Fields property enabled. type: string productClass: description: | This is used to maintain the product class. **Note**: This field is only available if you have the Additional Revenue Fields property enabled. type: string productFamily: description: | This is used to maintain the product family. **Note**: This field is only available if you have the Additional Revenue Fields property enabled. type: string productLine: description: | This is used to maintain the product line. **Note**: This field is only available if you have the Additional Revenue Fields property enabled. type: string productRatePlanChargeId: description: '' type: string quantity: description: | The quantity of units, such as the number of authors in a hosted wiki service. Valid for all charge models except for Flat Fee pricing. type: number ratingGroup: description: | Specifies a rating group based on which usage records are rated. Possible values: - `ByBillingPeriod` (default): The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. **Note:** - The `ByBillingPeriod` value can be applied for all charge models. - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. - The `ByGroupId` value is only available if you have the Active Rating feature enabled. - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. type: string reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set both the `excludeItemBookingFromRevenueAccounting` and `excludeItemBillingFromRevenueAccounting` fields to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. revenueRecognitionTiming: description: | Specifies the type of revenue recognition timing. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. maxLength: 200 type: string enum: - Upon Billing Document Posting Date - Upon Order Activation Date revenueAmortizationMethod: description: | Specifies the type of revenue amortization method. Predefined options are listed as enum values in this API Reference. Other options might also be avaliable depending on the revenue recognition policy configuration in the Zuora Billing UI. **Note**: This field is only available if you have the Order to Revenue feature enabled. maxLength: 200 type: string enum: - Immediate - Ratable Using Start And End Dates rolloverApply: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. This field defines the priority of rollover, which is either first or last. enum: - ApplyFirst - ApplyLast type: string rolloverPeriodLength: default: null description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. In this case, you must set the `rolloverPeriods` field to 1. For example, you can define the rollover fund's period length as 5 months, shorter than the prepayment charge's validity period: a year. type: integer rolloverPeriods: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. This field defines the number of rollover periods, it is restricted to 3. type: number segment: description: | The identifying number of the subscription rate plan segment. Segments are numbered sequentially, starting with 1. format: int64 type: integer smoothingModel: description: | Specifies when revenue recognition begins. When charge model is `Overage` or `TieredWithOverage`, `smoothingModel` will be one of the following values: * `ContractEffectiveDate` * `ServiceActivationDate` * `CustomerAcceptanceDate` type: string specificBillingPeriod: description: | Customizes the number of month or week for the charges billing period. This field is required if you set the value of the `BillingPeriod` field to `Specific_Months` or `Specific_Weeks`. format: int64 type: integer specificEndDate: description: | The specific date on which the charge ends. If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. format: date type: string specificListPriceBase: description: | The number of months for the list price base of the charge. **Note**: - This field is available only if you have the Annual List Price feature enabled. - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. subscriptionChargeDeliverySchedule: $ref: '#/components/schemas/GETDeliveryScheduleType' subscriptionChargeIntervalPricing: description: | Interval Pricing information. This field is available if the Offers feature is enabled. items: $ref: '#/components/schemas/GETIntervalPriceType' type: array tcv: description: | The total contract value. type: number tiers: description: | One or many defined ranges with distinct pricing. items: $ref: '#/components/schemas/GETTierType' type: array triggerDate: description: | The date that the rate plan charge will be triggered. format: date type: string triggerEvent: description: | The event that will cause the rate plan charge to be triggered. Possible values: * `ContractEffective` * `ServiceActivation` * `CustomerAcceptance` * `SpecificDate` type: string type: description: | Charge type. Possible values are: `OneTime`, `Recurring`, `Usage`. type: string unusedUnitsCreditRates: description: | Specifies the rate to credit a customer for unused units of usage. This field is applicable only for overage charge models when the `OverageUnusedUnitsCreditOption` field value is `CreditBySpecificRate`. type: number upsellOriginChargeNumber: description: | The identifier of the original upselling charge associated with the current charge. For a termed subscription, you can now use the "Create an order" API operation to perform an Add Product order action to make a product quantity upsell for per unit recurring charges. The benefit is that the charge added by this approach will be automatically combined with the original existing charge for which you want to upsell when the subscription is renewed. The approach is as follows: * Use an Add Product order action to add a charge that is of the same charge type, charge model, and charge end date as the existing per unit recurring charge for which you want to make a quantity upsell. * In the preceding charge to add, use the `upsellOriginChargeNumber` field to specify the existing rate plan charge for which you want to make the quantity upsell. Note that a termed subscription with such upsell charges can not be changed to an evergreen subscription. **Note**: The Quantity Upsell 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. If you want to join this early adopter program, submit a request at [Zuora Global Support](https://support.zuora.com). type: string uom: description: | Specifies the units to measure usage. type: string upToPeriods: description: | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. If the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge end date will change accordingly up to the original period end. type: string upToPeriodsType: description: | The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` type: string usageRecordRatingOption: description: | Determines how Zuora processes usage records for per-unit usage charges. type: string validityPeriodType: description: | **Note**: This field is only available if you have the [Prepaid with Drawdown](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown) feature enabled. The period in which the prepayment units are valid to use as defined in a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge). enum: - SUBSCRIPTION_TERM - ANNUAL - SEMI_ANNUAL - QUARTER - MONTH type: string version: description: | Rate plan charge revision number. format: int64 type: integer type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: ratePlanCharges GETSubscriptionProductFeatureType: properties: description: description: | Feature description. type: string featureCode: description: | Feature code, up to 255 characters long. type: string id: description: | SubscriptionProductFeature ID. type: string name: description: | Feature name, up to 255 characters long. type: string title: subscriptionProductFeatures type: object RatePlanChargeSegment: type: object title: ratePlanChargeSegment properties: id: type: string description: | ID of the charge. amendedByOrderOn: description: | The date when the rate plan charge is amended through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. format: date type: string applyDiscountTo: type: string enum: - ONETIME - RECURRING - USAGE - ONETIMERECURRING - ONETIMEUSAGE - RECURRINGUSAGE - ONETIMERECURRINGUSAGE - null description: | Specifies the type of charges a specific discount applies to. This field is only used when applied to a discount charge model. If you are not using a discount charge model, the value is `null`. nullable: true chargeFunction: description: | **Note**: This field is only available if you have the Unbilled Usage feature enabled. Define what type of charge it is in Advanced consumption billing: * `Standard`: Normal charge with no Prepayment or Commitment or Drawdown. * `Prepayment`: For recurring charges. Unit or currency based prepaid charge. * `CommitmentTrueUp`: For recurring charges. Currency based minimum commitment charge. * `Drawdown`: For usage charges. Drawdown from prepaid funds. * `DrawdownAndCreditCommitment`: For usage charges. Drawdown from prepaid funds and then credit to minimum commitment funds. * `CreditCommitment`: For usage charges. Credit to minimum commitment funds. enum: - Standard - Prepayment - CommitmentTrueUp - Drawdown - CreditCommitment - DrawdownAndCreditCommitment type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' chargedThroughDate: description: | The date through which a customer has been billed for the charge. format: date type: string commitmentType: description: | **Note**: This field is only available if you have the Unbilled Usage feature enabled. The type of commitment. A prepaid charge can be `UNIT` or `CURRENCY`. And a min commitment(in-arrears) charge can only be CURRENCY type. For topup(recurring/one-time) charges, this field indicates what type of funds are created. * If `UNIT`, it will create a fund with given prepaidUom. * If `CURRENCY`, it will create a fund with the currency amount calculated in list price. For drawdown(usage) charges, this field indicates what type of funds are drawdown from that created from topup charges. enum: - UNIT - CURRENCY type: string prepaidCommittedAmount: type: string description: | **Note**: This field is only available if you have the Prepaid with Drawdown enabled. The amount of the prepaid committed amount. nullable: true creditOption: description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. \nTo use this field, you must set the `X-Zuora-WSDL-Version` request header to 114 or higher. Otherwise, an error occurs. The way to calculate credit. See Credit Option for more information. enum: - TimeBased - ConsumptionBased - FullCreditBack - null type: string nullable: true currency: $ref: '#/components/schemas/Currency' deliverySchedule: $ref: '#/components/schemas/GETDeliveryScheduleType' numberOfDeliveries: type: number description: | The number of the deliveries. nullable: true description: description: Description of the rate plan charge segment. type: string discountAmount: description: The amount of the discount. type: number nullable: true discountApplyDetails: description: | Container for the application details about a discount rate plan charge. Only discount rate plan charges have values in this field. items: $ref: '#/components/schemas/DiscountApplyDetails' type: array nullable: true discountClass: description: | The class that the discount belongs to. The discount class defines the order in which discount rate plan charges are applied. For more information, see Manage Discount Classes. type: string nullable: true discountLevel: $ref: '#/components/schemas/DiscountLevel' discountPercentage: description: | The amount of the discount as a percentage. type: number nullable: true applyToBillingPeriodPartially: type: boolean description: | A value of `true` indicates that the charge segment is applied to a billing period partially. The value of this field is `false` by default. default: false dmrc: description: | The change (delta) of monthly recurring charge exists when the change in monthly recurring revenue caused by an amendment or a new subscription. type: number format: double done: description: | A value of `true` indicates that an invoice for a charge segment has been completed. A value of `false` indicates that an invoice has not been completed for the charge segment. type: boolean drawdownRate: type: number description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. The conversion rate between Usage UOM and Drawdown UOM for a drawdown charge. Must be a positive number (>0). drawdownUom: $ref: '#/components/schemas/Uom' dtcv: description: | After an amendment or an AutomatedPriceChange event, `dtcv` displays the change (delta) for the total contract value (TCV) amount for this charge, compared with its previous value with recurring charge types. type: number format: double effectiveEndDate: format: date type: string description: | The effective end date of the charge. effectiveStartDate: format: date type: string description: | The effective start date of the charge. endDateCondition: $ref: '#/components/schemas/EndDateCondition' includedUnits: type: number description: | The number of units included in this charge segment. inputArgumentId: type: string description: | The ID of the input argument for the charge segment. isCommitted: type: boolean description: | Indicates if the charge segment is committed. isPrepaid: type: boolean description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. Indicates whether this charge is a prepayment (topup) charge or a drawdown charge. isRollover: type: boolean description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. It determines whether the rollover fields are needed. mrr: type: number format: double description: | Monthly recurring revenue (MRR) is the amount of recurring charges in a given month. The MRR calculation doesn't include one-time charges nor usage charges. originalOrderDate: format: date type: string description: | The date when the rate plan charge is created through an order or amendment. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sales order line in Zuora Revenue. overagePrice: type: number description: | Price for units over the allowed amount. Available for the usage-based charge type for the Overage and Tiered with Overage charge models. prepaidOperationType: enum: - topup - drawdown type: string description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. The type of this charge. It is either a prepayment (topup) charge or a drawdown charge. prepaidQuantity: type: number description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. The number of units included in a prepayment charge. prepaidTotalQuantity: type: number description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. The total amount of units that end customers can use during a validity period when they subscribe to a prepayment charge. prepaidUOM: $ref: '#/components/schemas/Uom' quantity: type: number description: | Number of units purchased. price: type: number description: | The price of the charge segment. priceChangeOption: $ref: '#/components/schemas/PriceChangeOption' priceIncreasePercentage: type: number nullable: true description: | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Use this field if you set the `PriceChangeOption` value to `SpecificPercentageValue`. 1. AutomatedPriceChange setting is on 2. Charge type is not one-time 3. Charge model is not discount fixed amount minimum: -100 maximum: 100 pricingSummary: type: string description: | A concise description of the charge model and pricing that is suitable to show to your customers. originalListPrice: type: number nullable: true description: | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. processedThroughDate: format: date type: string description: | The date until when charges have been processed. When billing in arrears, such as usage, this field value is the the same as the `ChargedThroughDate` value. This date is the earliest date when a charge can be amended. rolloverApply: enum: - ApplyFirst - ApplyLast type: string description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the priority of rollover, which is either first or last. rolloverPeriodLength: type: integer description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. Use this field when you want to set the rollover fund's period length shorter than the prepayment charge's validity period. rolloverPeriods: format: int64 type: integer description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. This field defines the number of rollover periods, it is restricted to 3. prorationOption: type: string description: | **Note**: This field is only available if you have the Charge Level Proration feature enabled. The charge-level proration option for the product rate plan charge. segment: format: int64 type: integer description: | Segment number of the charge. specificEndDate: format: date type: string description: | Defines when the charge ends after the charge trigger date. This field is only applicable when the `endDateCondition` field is `Specific_End_Date`. subscriptionChargeIntervalPricing: items: $ref: '#/components/schemas/GETIntervalPriceType' type: array tcv: type: number format: double description: | Total contract value (TCV) is the sum of one-time charges, recurring charges, and usage charges. The TCV calculation includes one-time charges, recurring charges, and usage charges. tiers: items: $ref: '#/components/schemas/RatePlanChargeTier' type: array nullable: true triggerDate: format: date type: string nullable: true description: | The date when the charge becomes effective and billing begins, in `yyyy-mm-dd` format. billingPeriodAlignment: $ref: '#/components/schemas/BillingPeriodAlignment' triggerEvent: $ref: '#/components/schemas/TriggerEvent' upToPeriods: format: int64 type: integer nullable: true description: | Specifies the length of the period during which the charge is active. If this period ends before the subscription ends, the charge ends when this period ends. The value is inherited from `ProductRatePlanCharge.UpToPeriods` field. upToPeriodsType: $ref: '#/components/schemas/UpToPeriodsType' validityPeriodType: $ref: '#/components/schemas/ValidityPeriodType' salesPrice: type: number format: double description: | The sales price of the charge segment. accountingCode: type: string nullable: true description: | The accounting code of the charge segment. revenueRecognitionCode: type: string nullable: true description: | The revenue recognition code of the charge segment. revRecTriggerCondition: type: string nullable: true description: | Specifies when revenue recognition begins. estimatedEndDate: format: date type: string description: | The estimated end date of the charge segment. estimatedStartDate: format: date type: string description: | The estimated start date of the charge segment. taxable: type: boolean nullable: true description: | Indicates whether the charge is taxable. taxCode: type: string nullable: true description: | The tax code of a charge. taxMode: type: string nullable: true description: | Determines how to define taxation for the charge. It affects the tax calculation of the charge. enum: - TaxExclusive - TaxInclusive - null DiscountApplyDetails: properties: appliedProductName: description: | The name of the product that the discount rate plan charge applies to. type: string appliedProductRatePlanChargeId: description: | The ID of the product rate plan charge that the discount rate plan charge applies to. type: string appliedProductRatePlanChargeName: description: | The name of the product rate plan charge that the discount rate plan charge applies to. type: string appliedProductRatePlanId: description: | The ID of the product rate plan that the discount rate plan charge applies to. type: string appliedProductRatePlanName: description: | The name of the product rate plan that the discount rate plan charge applies to. type: string title: discountApplyDetails type: object GETDeliveryScheduleType: description: | The `deliverySchedule` is used for the Delivery Pricing charge model only. **Note**: The Delivery Pricing charge model 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. You can check **Delivery Pricing** in **Billing Settings** > **Enable Charge Types / Models**. properties: frequency: description: | Specifies delivery frequency for the delivery schedule. enum: - Weekly type: string friday: description: | Indicates whether delivery occurs on Friday. type: boolean monday: description: | Indicates whether delivery occurs on Monday. type: boolean saturday: description: | Indicates whether delivery occurs on Saturday. type: boolean sunday: description: | Indicates whether delivery occurs on Sunday. type: boolean thursday: description: | Indicates whether delivery occurs on Thursday. type: boolean tuesday: description: | Indicates whether delivery occurs on Tuesday. type: boolean wednesday: description: | Indicates whether delivery occurs on Wednesday. type: boolean title: deliverySchedule type: object GETIntervalPriceType: properties: duration: description: | Duration period of this interval. type: integer price: description: | Price of this interval. type: number sequence: description: | A system-generated number that indicates the sequence in which each interval price is billed. type: integer subscriptionChargeIntervalPriceTiers: items: $ref: '#/components/schemas/GETIntervalPriceTierType' type: array type: description: | Interval type of this pricing. enum: - Day - Month - Infinity type: string title: IntervalPricing type: object GETTierType: properties: endingUnit: description: | Decimal defining end of tier range. type: number originalListPrice: description: | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. **Note:** This field applies to the following charges in a subscription created through an order: - `oneTimeTiered` - `oneTimeVolume` - `recurringTiered` - `recurringVolume` - `usageTiered` - `usageVolume` - `usageTieredWithOverage` type: number price: description: | The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies. type: number priceFormat: description: | Tier price format. Allowed values: `flat fee`, `per unit`. type: string startingUnit: description: | Decimal defining start of tier range. type: number tier: description: | Unique number of the tier. format: int64 type: integer title: tiers type: object GETIntervalPriceTierType: properties: endingUnit: description: | Decimal defining end of tier range. type: number isOveragePrice: description: | True if the price is overage price for the tier. type: boolean price: description: | The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies. type: number priceFormat: description: | Tier price format. Allowed values: `flat fee`, `per unit`. type: string startingUnit: description: | Decimal defining start of tier range. type: number tier: description: | Unique number of the tier. format: int64 type: integer title: IntervalPricing type: object Currency: type: string description: Currency used by the account. For example, `USD` or `EUR`. DiscountLevel: type: string enum: - rateplan - subscription - account description: | The level of the discount. For example, if the value of this field is `subscription` and the value of the `applyDiscountTo` field is `RECURRING`, the discount charge applies to all recurring charges in the same subscription as the discount charge. Uom: description: Specifies the units to measure usage. type: string EndDateCondition: description: | Condition for the charge to become inactive. If the value of this field is `Fixed_Period`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields. If the value of this field is `Specific_End_Date`, use the `specificEndDate` field to specify the date when then charge becomes inactive. type: string enum: - Subscription_End - Fixed_Period - Specific_End_Date - One_Time PriceChangeOption: type: string description: | Applies an automatic price change when a termed subscription is renewed. enum: - NoChange - SpecificPercentageValue - UseLatestProductCatalogPricing - null default: NoChange nullable: true RatePlanChargeTier: type: object title: chargeTier properties: tier: description: | Unique number of the tier. format: int64 type: integer minimum: 1 startingUnit: description: | Decimal defining start of tier range. type: number format: double endingUnit: description: | Decimal defining end of tier range. type: number format: double price: description: | The decimal value of the tiered charge model. If the charge model is not a tiered type then this price field will be null and the `price` field directly under the `productRatePlanCharges` applies. type: number priceFormat: description: | Tier price format. type: string enum: - FlatFee - PerUnit originalListPrice: type: number format: double description: | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. BillingPeriodAlignment: description: | Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges. * `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active. * `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription. * `AlignToTermStart` - For each term of the subscription, Zuora starts a new billing period on the first billing day that falls on or after the start date of the term. See the `billCycleType` field for information about how Zuora determines the billing day. **Note:** `AlignToTermEnd` is only available for prepayment charges by default. To enable this value for non-prepaid recurring charges, contact Zuora Global Support. enum: - AlignToCharge - AlignToSubscriptionStart - AlignToTermStart - AlignToTermEnd type: string TriggerEvent: description: | Condition for the charge to become active. If this field is not specified, the value of the field will be defaulted to the trigger event value defined in the product catalog. If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active. type: string enum: - ContractEffective - ServiceActivation - CustomerAcceptance - SpecificDate UpToPeriodsType: description: | Unit of time that the charge duration is measured in. Only applicable if the value of the `endDateCondition` field is `Fixed_Period`. type: string enum: - Days - Weeks - Months - Years - Billing_Periods - null nullable: true ValidityPeriodType: description: | **Note**: This field is only available if you have the Prepaid with Drawdown feature enabled. The period in which the prepayment units are valid to use as defined in a prepayment charge. type: string enum: - SUBSCRIPTION_TERM - ANNUAL - SEMI_ANNUAL - QUARTER - MONTH - null nullable: true GETSubscriptionByKeyWithSuccess: allOf: - properties: accountId: description: The ID of the account associated with this subscription. type: string accountName: description: The name of the account associated with this subscription. type: string accountNumber: description: The number of the account associated with this subscription. type: string autoRenew: description: | If `true`, the subscription automatically renews at the end of the term. Default is `false`. type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: description: | The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`. type: string contractEffectiveDate: description: | Effective contract date for this subscription, as yyyy-mm-dd. format: date type: string contractedMrr: description: | Monthly recurring revenue of the subscription. type: number contractedNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number asOfDayGrossMrr: description: | Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day. type: number asOfDayNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day. type: number netTotalContractedValue: description: | Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number currency: description: | The currency of the subscription. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string currentTerm: description: | The length of the period for the current subscription term. format: int64 type: integer currentTermPeriodType: description: | The period type for the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. format: date type: string externallyManagedBy: description: | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. enum: - Amazon - Apple - Google - Roku type: string id: description: | Subscription ID. type: string initialTerm: description: | The length of the period for the first subscription term. format: int64 type: integer initialTermPeriodType: description: | The period type for the first subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string invoiceGroupNumber: description: | The number of the invoice group associated with the subscription. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true invoiceOwnerAccountId: description: '' type: string invoiceOwnerAccountName: description: '' type: string invoiceOwnerAccountNumber: description: '' type: string invoiceScheduleId: description: | The ID of the invoice schedule associated with the subscription. If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: integer invoiceSeparately: description: | Separates a single subscription from other subscriptions and creates an invoice for the subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. type: boolean invoiceTemplateId: description: | The ID of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string nullable: true invoiceTemplateName: description: | The name of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body. type: string isLatestVersion: description: If `true`, the current subscription object is the latest version. type: boolean lastBookingDate: description: |- The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date. format: date type: string notes: description: | A string of up to 65,535 characters. type: string orderNumber: description: | The order number of the order in which the changes on the subscription are made. **Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string originalListPrice: description: | The original list price is the price of a product or service at which it is listed for sale by a manufacturer or retailer. **Note:** This field applies to the following charges in a subscription created through an order: - `oneTimeFlatFee` - `oneTimePerUnit` - `recurringFlatFee` - `recurringPerUnit` - `usageFlatFee` - `usagePerUnit` - `usageOverage` - `usageTieredWithOverage` type: number paymentTerm: description: | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string ratePlans: description: | Container for rate plans. items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: description: | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. Values are: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` type: string renewalTerm: description: | The length of the period for the subscription renewal term. format: int64 type: integer renewalTermPeriodType: description: | The period type for the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string revision: description: | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions. type: string sequenceSetId: description: | The ID of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the subscription. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true sequenceSetName: description: | The name of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body. type: string serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: description: | Subscription status; possible values are: * `Draft` * `Pending Activation` * `Pending Acceptance` * `Active` * `Cancelled` * `Suspended` type: string statusHistory: description: | Container for status history. items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: description: | The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate. format: date type: string subscriptionNumber: description: Subscription number. type: string subscriptionStartDate: description: | Date the subscription becomes effective. format: date type: string success: description: | Returns `true` if the request was processed successfully. type: boolean termEndDate: description: | Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). format: date type: string termStartDate: description: | Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string scheduledCancelDate: description: The date when the subscription is scheduled to be canceled. format: date type: string scheduledSuspendDate: description: The date when the subscription is scheduled to be suspended. format: date type: string scheduledResumeDate: description: The date when the subscription is scheduled to be resumed. format: date type: string totalContractedValue: description: | Total contracted value of the subscription. type: number version: description: This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment. format: int64 type: integer accountOwnerDetails: $ref: '#/components/schemas/GETAccountTypeBasicInfo' invoiceOwnerAccountDetails: $ref: '#/components/schemas/GETAccountTypeBasicInfo' type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' PUTSubscriptionType: allOf: - properties: add: description: | Container for adding one or more rate plans. items: $ref: '#/components/schemas/PUTSrpAddType' type: array applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | Whether to automatically apply credit memos or unapplied payments, or both to an invoice. If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the invoice. If no value is specified or the value is `false`, no action is taken. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean autoRenew: description: | If `true`, this subscription automatically renews at the end of the subscription term. Default is `false`. type: boolean bookingDate: description: | The booking date that you want to set for the contract when you change the `termType` field of the subscription and as a result get a new version of subscription created. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. format: date type: string change: description: | Use this field to change one or more rate plans - to replace the existing rate plans in a subscription with other rate plans. **Note**: Changing rate plans is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, changing rate plans will no longer be applicable in Zuora Billing. items: $ref: '#/components/schemas/PUTSrpChangeType' type: array collect: default: false description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or a later available version. type: boolean creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string currentTerm: description: | The length of the period for the current subscription term. If `termType` is `TERMED`, this field is required and must be greater than `0`. If `termType` is `EVERGREEN`, this value is ignored. format: int64 type: integer currentTermPeriodType: description: | The period type for the current subscription term. This field is used with the `CurrentTerm` field to specify the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string externallyManagedBy: description: | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. enum: - Amazon - Apple - Google - Roku type: string includeExistingDraftDocItems: description: | Specifies whether to include draft invoice items in subscription previews. Values are: * `true` (default). Includes draft invoice items in the preview result. * `false`. Excludes draft invoice items in the preview result. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `207.0` or a later available version. type: boolean invoiceSeparately: description: | Separates a single subscription from other subscriptions and invoices the charge independently. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. The default value is `false`. Prerequisite: The default subscription setting Enable Subscriptions to be Invoiced Separately must be set to Yes. type: boolean notes: description: | The notes for the subscription. maxLength: 1000 type: string preview: description: | If `true` the update is made in preview mode. The default setting is `false`. type: boolean previewType: description: | The type of preview you will receive. **Note**: If your API minor version is earlier than `206.0` or you specify the `Zuora-Version` header for this request to `206.0` or earlier, the following values are supported for the `previewType` field: - `InvoiceItem` (default) - `ChargeMetrics` - `InvoiceItemChargeMetrics` enum: - LegalDoc - ChargeMetrics - LegalDocChargeMetrics default: LegalDoc type: string remove: description: | Container for removing one or more rate plans. items: $ref: '#/components/schemas/PUTSrpRemoveType' type: array renewalSetting: description: | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. Values are: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` type: string renewalTerm: description: | The length of the period for the subscription renewal term. Default is `0`. format: int64 type: integer renewalTermPeriodType: description: | The period type for the subscription renewal term. This field is used with the `renewalTerm` field to specify the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string runBilling: default: false description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or a later available version. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. type: boolean targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled. This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `211.0` or a later available version. format: date type: string termStartDate: description: | Date the subscription term begins, as yyyy-mm-dd. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string update: description: | Container for updating one or more rate plans. items: $ref: '#/components/schemas/PUTSrpUpdateType' type: array type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' example: autoRenew: true PUTSubscriptionResponseType: properties: chargeMetrics: description: | Container for charge metrics. This field is available only if the `preview` field in the request body is `true`. properties: dmrr: description: | Change in total contract value. type: string dtcv: description: | Change in monthly recurring revenue. type: string mrr: description: | Monthly recurring revenue. type: string number: description: | The charge number of the subscription. Only available for update subscription. type: string originRatePlanId: description: | The origin rate plan ID. Only available for update subscription. type: string originalId: description: | The original rate plan charge ID. Only available for update subscription. type: string productRatePlanChargeId: description: '' type: string productRatePlanId: description: '' type: string tcv: description: | Total contract value. type: string type: object creditMemo: description: | Container for credit memos. This field is available only if the `preview` field in the request body is `true`. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. properties: amount: description: Credit memo amount. format: double type: number amountWithoutTax: description: Credit memo amount minus tax. format: double type: number creditMemoItems: description: '' items: $ref: '#/components/schemas/POSTSubscriptionPreviewCreditMemoItemsType' type: array taxAmount: description: Tax amount on the credit memo. format: double type: number type: object creditMemoId: description: | The credit memo ID. This field is available only if the `preview` field in the request body is `false` and a credit memo is generated during the update. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoice: description: | Container for invoices. This field is available only if the `preview` field in the request body is `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). Also, the response structure is changed and the following invoice related response fields are moved to this **invoice** container: * amount * amountWithoutTax * taxAmount * invoiceItems * targetDate properties: amount: description: Invoice amount. format: double type: number amountWithoutTax: description: | Invoice amount minus tax. format: double type: number invoiceItems: description: | Container for invoice items. items: $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType' type: array targetDate: description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string taxAmount: description: | The tax amount of the invoice. format: double type: number type: object invoiceId: description: | The ID of the generated invoice. This field is available only if the `preview` field in the request body is `false` and an invoice is generated during the update. type: string invoiceItems: description: | Container for invoice items. This field is available only if the `preview` field in the request body is `true`. items: $ref: '#/components/schemas/PUTSubscriptionPreviewInvoiceItemsType' type: array paidAmount: description: | Payment amount, if a payment is collected type: number paymentId: description: | Payment ID, if a payment is collected. type: string subscriptionId: description: | The ID of the resulting new subscription. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean targetDate: description: | Date through which to calculate charges if an invoice is generated, as yyyy-mm-dd. Default is current date. This field is available only if the `preview` field in the request body is `true`. **Note:** This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `207.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string taxAmount: description: | Tax amount on the invoice. This field is available only if the `preview` field in the request body is `true`. type: number totalDeltaMrr: description: | Change in the subscription monthly recurring revenue as a result of the update. type: number totalDeltaTcv: description: | Change in the total contracted value of the subscription as a result of the update. type: number type: object PUTSubscriptionPreviewInvoiceItemsType: properties: chargeAmount: description: | The amount of the charge. This amount doesn't include taxes unless the charge's tax mode is inclusive. type: number chargeDescription: description: | Description of the charge. type: string chargeName: description: | Name of the charge type: string productName: description: | Name of the product associated with this item. type: string productRatePlanChargeId: description: '' type: string quantity: description: | Quantity of this item. type: number serviceEndDate: description: | End date of the service period for this item, i.e., the last day of the period, as yyyy-mm-dd. format: date type: string serviceStartDate: description: | Service start date as yyyy-mm-dd. If the charge is a one-time fee, this is the date of that charge. format: date type: string taxationItems: description: |- List of taxation items. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `315.0` or a later available version. items: $ref: '#/components/schemas/POSTSubscriptionPreviewTaxationItemsType' type: array unitOfMeasure: description: '' type: string title: invoiceItems type: object PUTSrpAddType: allOf: - properties: bookingDate: description: | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. format: date type: string chargeOverrides: description: | This optional container is used to override the quantity of one or more product rate plan charges for this subscription. items: $ref: '#/components/schemas/PUTScAddType' type: array contractEffectiveDate: description: | The date when the amendment changes take effect. The format of the date is yyyy-mm-dd. If there is already a future-dated Update Product amendment on the subscription, the `specificUpdateDate` field will be used instead of this field to specify when the Update Product amendment takes effect. format: date type: string customerAcceptanceDate: description: | The date when the customer accepts the contract in yyyy-mm-dd format. If this field is not set: * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string externalCatalogPlanId: description: | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. **Note:** If both `externalCatalogPlanId` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externalIdSourceSystem: description: | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externallyManagedPlanId: description: | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. type: string productRatePlanId: description: | ID of a product rate plan for this subscription type: string productRatePlanNumber: description: | Number of a product rate plan for this subscription type: string serviceActivationDate: description: | The date when the new product in the subscription is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string required: - contractEffectiveDate type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: add PUTSrpChangeType: allOf: - properties: bookingDate: description: | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. format: date type: string chargeOverrides: description: This optional container is used to override one or more product rate plan charges for this subscription. items: $ref: '#/components/schemas/PUTScAddType' type: array contractEffectiveDate: description: Effective date of the new subscription, as yyyy-mm-dd. format: date type: string customerAcceptanceDate: description: | The date when the customer accepts the contract in yyyy-mm-dd format. When this field is not set: * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string effectivePolicy: description: | The default value for the `effectivePolicy` field is as follows: * If the rate plan change (from old to new) is an upgrade, the effective policy is `EffectiveImmediately` by default. * If the rate plan change (from old to new) is a downgrade, the effective policy is `EffectiveEndOfBillingPeriod` by default. * Otherwise, the effective policy is `SpecificDate` by default. **Notes**: * When setting this field to `EffectiveEndOfBillingPeriod`, you cannot set the billing trigger dates for the subscription as the system will automatically set the trigger dates to the end of billing period. * When setting this field to `SpecificDate`, you must also set the `contractEffectiveDate` field. enum: - EffectiveImmediately - EffectiveEndOfBillingPeriod - SpecificDate type: string externalCatalogPlanId: description: | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case. **Note:** Provide only one of `externalCatalogPlanId`, `ratePlanId` or `productRatePlanId`. If more than one field is provided then the request would fail. type: string externalIdSourceSystem: description: | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string newExternalCatalogPlanId: description: | An external ID of the product rate plan to be added. You can use this field to specify a product rate plan that is imported from an external system. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. **Note:** Provide only one of `newExternalCatalogPlanId` or `newProductRatePlanId`. If both fields are provided then the request would fail. type: string newExternalIdSourceSystem: description: | The ID of the external source system. You can use this field and `newExternalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `newExternalCatalogPlanId`, `newExternalIdSourceSystem` and `newProductRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string newProductRatePlanId: description: ID of a product rate plan for this subscription. type: string newProductRatePlanNumber: description: Number of a product rate plan for this subscription. type: string productRatePlanId: description: | ID of the product rate plan that the removed rate plan is based on. type: string productRatePlanNumber: description: 'Number of a product rate plan for this subscription. ' type: string ratePlanId: description: | ID of a rate plan to remove. Note that the removal of a rate plan through the Change Plan amendment supports the function of removal before future-dated removals, as in a Remove Product amendment. type: string resetBcd: default: false description: | If resetBcd is true then reset the Account BCD to the effective date; if it is false keep the original BCD. type: boolean serviceActivationDate: description: 'The date when the change in the subscription is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate' format: date type: string subType: description: | Use this field to choose the sub type for your change plan amendment. However, if you do not set this field, the field will be automatically generated by the system according to the following rules: When the old and new rate plans are within the same Grading catalog group: * If the grade of new plan is greater than that of the old plan, this is an "Upgrade". * If the grade of new plan is less than that of the old plan, this is a "Downgrade". * If the grade of new plan equals that of the old plan, this is a "Crossgrade". When the old and new rate plans are not in the same Grading catalog group, or either has no group, this is "PlanChanged". enum: - Upgrade - Downgrade - Crossgrade - PlanChanged type: string subscriptionRatePlanNumber: description: 'Number of a rate plan for this subscription. ' type: string type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: change PUTSrpRemoveType: properties: bookingDate: description: | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. format: date type: string contractEffectiveDate: description: | Effective date of the new subscription, as yyyy-mm-dd. format: date type: string customerAcceptanceDate: description: | The date when the customer accepts the contract in yyyy-mm-dd format. If this field is not set: * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string externalCatalogPlanId: description: | An external ID of the rate plan to be removed. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to remove the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case. **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externalIdSourceSystem: description: | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string productRatePlanNumber: description: | Number of a product rate plan for this subscription. type: string ratePlanId: description: | ID of a rate plan for this subscription. This can be the latest version or any history version of ID. type: string serviceActivationDate: description: | The date when the remove amendment is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string subscriptionRatePlanNumber: description: | Number of a rate plan for this subscription. type: string required: - contractEffectiveDate title: remove type: object PUTSrpUpdateType: allOf: - properties: bookingDate: description: | The booking date that you want to set for the amendment contract. The booking date of an amendment is the equivalent of the order date of an order. This field must be in the `yyyy-mm-dd` format. The default value is the current date when you make the API call. format: date type: string chargeUpdateDetails: description: | Container for one or more product rate plan charges. items: $ref: '#/components/schemas/PUTScUpdateType' type: array contractEffectiveDate: description: | The date when the amendment changes take effect. The format of the date is yyyy-mm-dd. If there is already a future-dated Update Product amendment on the subscription, the `specificUpdateDate` field will be used instead of this field to specify when the Update Product amendment takes effect. format: date type: string customerAcceptanceDate: description: | The date when the customer accepts the contract in yyyy-mm-dd format. If this field is not set: * If the `serviceActivationDate` field is not set, the value of this field is set to be the contract effective date. * If the `serviceActivationDate` field is set, the value of this field is set to be the service activation date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string externalCatalogPlanId: description: | An external ID of the rate plan to be updated. You can use this field to specify an existing rate plan in your subscription. The value of the `externalCatalogPlanId` field must match one of the values that are predefined in the `externallyManagedPlanIds` field on a product rate plan. However, if there are multiple rate plans with the same `productRatePlanId` value existing in the subscription, you must use the `ratePlanId` field to update the rate plan. The `externalCatalogPlanId` field cannot be used to distinguish multiple rate plans in this case. **Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externalIdSourceSystem: description: | The ID of the external source system. You can use this field and `externalCatalogPlanId` to specify a product rate plan that is imported from an external system. **Note:** If both `externalCatalogPlanId`, `externalIdSourceSystem` and `productRatePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail. type: string externallyManagedPlanId: description: | Indicates the unique identifier for the rate plan purchased on a third-party store. This field is used to represent a subscription rate plan created through third-party stores. type: string productRatePlanNumber: description: | Number of a product rate plan for this subscription. type: string ratePlanId: description: | ID of a rate plan for this subscription. This can be the latest version or any history version of ID. type: string serviceActivationDate: description: | The date when the update amendment is activated in yyyy-mm-dd format. You must specify a Service Activation date if the Customer Acceptance date is set. If the Customer Acceptance date is not set, the value of the `serviceActivationDate` field defaults to be the Contract Effective Date. The billing trigger dates must follow this rule: contractEffectiveDate <= serviceActivationDate <= contractAcceptanceDate format: date type: string specificUpdateDate: description: | The date when the Update Product amendment takes effect. This field is only applicable if there is already a future-dated Update Product amendment on the subscription. The format of the date is yyyy-mm-dd. Required only for Update Product amendments if there is already a future-dated Update Product amendment on the subscription. format: date type: string subscriptionRatePlanNumber: description: | Number of a rate plan for this subscription. type: string required: - contractEffectiveDate type: object - $ref: '#/components/schemas/RatePlanObjectCustomFields' title: update PUTScUpdateType: allOf: - properties: billingPeriodAlignment: description: | Aligns charges within the same subscription if multiple charges begin on different dates. Values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` Available for the following charge types: * Recurring * Usage-based type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' description: description: | Description of the charge. type: string includedUnits: description: | Specifies the number of units in the base set of units for this charge. Must be >=0. Available for the following charge type for the Overage charge model: * Usage-based type: number overagePrice: description: | Price for units over the allowed amount. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based type: number price: description: | Price for units in the subscription rate plan. Supports all charge types for the Flat Fee and Per Unit charge models type: number priceChangeOption: description: | Applies an automatic price change when a termed subscription is renewed. The Billing Admin setting **Enable Automatic Price Change When Subscriptions are Renewed?** must be set to Yes to use this field. Values: * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` Available for the following charge types: * Recurring * Usage-based Not available for the Fixed-Amount Discount charge model. type: string priceIncreasePercentage: description: | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. Decimal between `-100` and `100`. Available for the following charge types: * Recurring * Usage-based Not available for the Fixed-Amount Discount charge model. type: number quantity: description: | Quantity of units; must be greater than zero. type: number ratePlanChargeId: description: | ID of a rate-plan charge for this subscription. It can be the latest version or any history version of ID. type: string tiers: description: | Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types: * One-time * Recurring * Usage-based items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: description: | Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to USD. `triggerDate` cannot be updated for the following using the REST update subscription call: * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model format: date type: string triggerEvent: description: | Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD` This is the date when charge changes in the REST request become effective. `triggerEvent` cannot be updated for the following using the REST update subscription call: * One-time charge type * Discount-Fixed Amount charge model * Discount-Percentage charge model type: string required: - ratePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeUpdateDetails PUTScAddType: allOf: - properties: amendedByOrderOn: description: | The date when the rate plan charge is amended through an order or amendment. This field is not updatable. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. type: string applyDiscountTo: description: | Specifies the type of charges that you want a specific discount to apply to. Values: * `ONETIME` * `RECURRING` * `USAGE` * `ONETIMERECURRING` * `ONETIMEUSAGE` * `RECURRINGUSAGE` * `ONETIMERECURRINGUSAGE` Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models: * Recurring type: string billCycleDay: description: | Sets the bill cycle day (BCD) for the charge. The BCD determines which day of the month customer is billed. Values: `1`-`31` Available for the following charge types: * Recurring * Usage-based type: string billCycleType: description: | Specifies how to determine the billing day for the charge. When this field is set to `SpecificDayofMonth`, set the `BillCycleDay` field. When this field is set to `SpecificDayofWeek`, set the `weeklyBillCycleDay` field. Values: * `DefaultFromCustomer` * `SpecificDayofMonth` * `SubscriptionStartDay` * `ChargeTriggerDay` * `SpecificDayofWeek` Available for the following charge types: * Recurring * Usage-based type: string billingPeriod: description: | Billing period for the charge. The start day of the billing period is also called the bill cycle day (BCD). When you renew a subscription, the current subscription term is extended by creating a new term. If any charge in your subscription has the billing period set as `SubscriptionTerm`， a new charge segment is generated for the new term. Values: * `Month` * `Quarter` * `Semi_Annual` * `Annual` * `Eighteen_Months` * `Two_Years` * `Three_Years` * `Five_Years` * `Specific_Months` * `Subscription_Term` * `Week` * `Specific_Weeks` Available for the following charge types: * Recurring * Usage-based type: string billingPeriodAlignment: description: | Aligns charges within the same subscription if multiple charges begin on different dates. Values: * `AlignToCharge` * `AlignToSubscriptionStart` * `AlignToTermStart` Available for the following charge types: * Recurring * Usage-based type: string billingTiming: description: | Billing timing for the charge for recurring charge types. Not avaliable for one time, usage and discount charges. Values: * `IN_ADVANCE` (default) * `IN_ARREARS` type: string chargeModelConfiguration: $ref: '#/components/schemas/ChargeModelConfigurationType' description: description: | Description of the charge. type: string discountAmount: description: | Specifies the amount of fixed-amount discount. Available for the following charge type for the Discount-Fixed Amount charge model: * Recurring type: number discountLevel: description: | Specifies if the discount applies to the product rate plan only , the entire subscription, or to any activity in the account. Values: * `rateplan` * `subscription` * `account` Available for the following charge type for the Discount-Fixed Amount and Discount-Percentage charge models: * Recurring type: string discountPercentage: description: | Specifies the percentage of a percentage discount. Available for the following charge type for the Discount-Percentage charge model: * Recurring type: number endDateCondition: description: | Defines when the charge ends after the charge trigger date. If the subscription ends before the charge end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the charge end date. Values: * `Subscription_End` * `Fixed_Period` * `Specific_End_Date` * `One_Time` type: string excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude rate plan charge related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean excludeItemBookingFromRevenueAccounting: default: false description: | The flag to exclude rate plan charges from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean includedUnits: description: | Specifies the number of units in the base set of units for this charge. Must be >=`0`. Available for the following charge type for the Overage charge model: * Usage-based type: number isAllocationEligible: description: | This field is used to identify if the charge segment is allocation eligible in revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean isUnbilled: description: | This field is used to dictate how to perform the accounting during revenue recognition. **Note**: The field is only available if you have the Order to Revenue feature enabled. To enable this field, submit a request at Zuora Global Support. type: boolean listPriceBase: description: | The list price base for the product rate plan charge. Values: * `Per_Billing_Period` * `Per_Month` * `Per_Week` * `Per_Year` * `Per_Specific_Months` Available for the following charge type for the Flat Fee, Per Unit, Volume Pricing, and Tiered Pricing charge models: * Recurring type: string number: description: | Unique number that identifies the charge. System-generated if not provided. type: string numberOfPeriods: description: | Specifies the number of periods to use when calculating charges in an overage smoothing charge model. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based format: int64 type: integer originalOrderDate: description: | The date when the rate plan charge is created through an order or amendment. This field is not updatable. This field is to standardize the booking date information to increase audit ability and traceability of data between Zuora Billing and Zuora Revenue. It is mapped as the booking date for a sale order line in Zuora Revenue. format: date type: string overagePrice: description: | Price for units over the allowed amount. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based type: number overageUnusedUnitsCreditOption: description: | Determines whether to credit the customer with unused units of usage. Values: * `NoCredit` * `CreditBySpecificRate` Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based type: string price: description: | Price for units in the subscription rate plan. Supports all charge types for the Flat Fee and Per Unit charge models type: number priceChangeOption: description: | Applies an automatic price change when a termed subscription is renewed. The Zuora Billing Admin setting Enable Automatic Price Change When Subscriptions are Renewed? must be set to Yes to use this field. See Define Default Subscription Settings for more information on setting this option. Values: * `NoChange` (default) * `SpecificPercentageValue` * `UseLatestProductCatalogPricing` Available for the following charge types: * Recurring * Usage-based * Not available for the Fixed-Amount Discount charge model. type: string priceIncreasePercentage: description: | Specifies the percentage to increase or decrease the price of a termed subscription's renewal. Required if you set the `PriceChangeOption` field to `SpecificPercentageValue`. Decimal between -100 and 100. Available for the following charge types: * Recurring * Usage-based Not available for the Fixed-Amount Discount charge model. type: number productRatePlanChargeId: description: '' type: string productRatePlanChargeNumber: description: 'Number of a product rate-plan charge for this subscription. ' type: string quantity: description: | Number of units. Must be >=`0`. Available for the following charge types for the Per Unit, Volume Pricing, and Tiered Pricing charge models: * One-time * Recurring type: number ratingGroup: description: | Specifies a rating group based on which usage records are rated. Possible values: - `ByBillingPeriod` (default): The rating is based on all the usages in a billing period. - `ByUsageStartDate`: The rating is based on all the usages on the same usage start date. - `ByUsageRecord`: The rating is based on each usage record. - `ByUsageUpload`: The rating is based on all the usages in a uploaded usage file (`.xls` or `.csv`). - `ByGroupId`: The rating is based on all the usages in a custom group. **Note:** - The `ByBillingPeriod` value can be applied for all charge models. - The `ByUsageStartDate`, `ByUsageRecord`, and `ByUsageUpload` values can only be applied for per unit, volume pricing, and tiered pricing charge models. - The `ByGroupId` value is only available if you have the Active Rating feature enabled. - Use this field only for Usage charges. One-Time Charges and Recurring Charges return `NULL`. type: string specificBillingPeriod: description: | Specifies the number of month or week for the charges billing period. Required if you set the value of the `billingPeriod` field to `Specific_Months` or `Specific_Weeks`. Available for the following charge types: * Recurring * Usage-based format: int64 type: integer specificEndDate: description: | Defines when the charge ends after the charge trigger date. This field is only applicable when the `endDateCondition` field is set to `Specific_End_Date`. If the subscription ends before the specific end date, the charge ends when the subscription ends. But if the subscription end date is subsequently changed through a Renewal, or Terms and Conditions amendment, the charge will end on the specific end date. format: date type: string specificListPriceBase: description: | The number of months for the list price base of the charge. This field is required if you set the value of the `listPriceBase` field to `Per_Specific_Months`. **Note**: - This field is available only if you have the Annual List Price feature enabled. - The value of this field is `null` if you do not set the value of the `listPriceBase` field to `Per_Specific_Months`. format: int32 maximum: 200 minimum: 1 type: integer tiers: description: | Container for Volume, Tiered or Tiered with Overage charge models. Supports the following charge types: * One-time * Recurring * Usage-based items: $ref: '#/components/schemas/POSTTierType' type: array triggerDate: description: | Specifies when to start billing the customer for the charge. Required if the `triggerEvent` field is set to `USD`. format: date type: string triggerEvent: description: | Specifies when to start billing the customer for the charge. Values: * `UCE` * `USA` * `UCA` * `USD` type: string unusedUnitsCreditRates: description: | Specifies the rate to credit a customer for unused units of usage. This field applies only for overage charge models when the `OverageUnusedUnitsCreditOption` field is set to `CreditBySpecificRate`. Available for the following charge type for the Overage and Tiered with Overage charge models: * Usage-based type: number upToPeriods: description: | The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` You must use this field together with the `upToPeriods` field to specify the time period. This field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. format: int64 type: integer upToPeriodsType: description: | The period type used to define when the charge ends. Values: * `Billing_Periods` * `Days` * `Weeks` * `Months` * `Years` You must use this field together with the `upToPeriods` field to specify the time period. This field is applicable only when the `endDateCondition` field is set to `Fixed_Period`. type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' title: chargeOverrides GETSubscriptionTypeWithSuccess: allOf: - properties: accountId: description: The ID of the account associated with this subscription. type: string accountName: description: The name of the account associated with this subscription. type: string accountNumber: description: The number of the account associated with this subscription. type: string autoRenew: description: | If `true`, the subscription automatically renews at the end of the term. Default is `false`. type: boolean billToContact: $ref: '#/components/schemas/GETAccountSummaryTypeBillToContact' cancelReason: description: | The reason for a subscription cancellation copied from the `changeReason` field of a Cancel Subscription order action. This field contains valid value only if a subscription is cancelled through the Orders UI or API. Otherwise, the value for this field will always be `null`. type: string contractEffectiveDate: description: | Effective contract date for this subscription, as yyyy-mm-dd. format: date type: string contractedMrr: description: | Monthly recurring revenue of the subscription, does not count in the discounts. type: number contractedNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number asOfDayGrossMrr: description: | Monthly recurring revenue of the subscription exclusive of any discounts applicable as of specified day. type: number asOfDayNetMrr: description: | Monthly recurring revenue of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day. type: number netTotalContractedValue: description: | Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number currency: description: | The currency of the subscription. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string currentTerm: description: | The length of the period for the current subscription term. format: int64 type: integer currentTermPeriodType: description: | The period type for the current subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string customerAcceptanceDate: description: | The date on which the services or products within a subscription have been accepted by the customer, as yyyy-mm-dd. format: date type: string externallyManagedBy: description: | An enum field on the Subscription object to indicate the name of a third-party store. This field is used to represent subscriptions created through third-party stores. enum: - Amazon - Apple - Google - Roku type: string id: description: | Subscription ID. type: string initialTerm: description: | The length of the period for the first subscription term. format: int64 type: integer initialTermPeriodType: description: | The period type for the first subscription term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string invoiceGroupNumber: description: | The number of the invoice group associated with the subscription. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true invoiceOwnerAccountId: description: '' type: string invoiceOwnerAccountName: description: '' type: string invoiceOwnerAccountNumber: description: '' type: string invoiceScheduleId: description: | The ID of the invoice schedule associated with the subscription. If multiple invoice schedules are created for different terms of a subscription, this field stores the latest invoice schedule. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: integer invoiceSeparately: description: | Separates a single subscription from other subscriptions and creates an invoice for the subscription. If the value is `true`, the subscription is billed separately from other subscriptions. If the value is `false`, the subscription is included with other subscriptions in the account invoice. type: boolean invoiceTemplateId: description: | The ID of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Template from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string invoiceTemplateName: description: | The name of the invoice template associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `invoiceTemplateId` field in the request or you select **Default Template from Account** for the `invoiceTemplateId` field during subscription creation, the value of the `invoiceTemplateName` field is automatically set to `null` in the response body. type: string isLatestVersion: description: If `true`, the current subscription object is the latest version. type: boolean lastBookingDate: description: |- The last booking date of the subscription object. This field is writable only when the subscription is newly created as a first version subscription. You can override the date value when creating a subscription through the Subscribe and Amend API or the subscription creation UI (non-Orders). Otherwise, the default value `today` is set per the user's timezone. The value of this field is as follows: * For a new subscription created by the [Subscribe and Amend APIs](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Migration_Guidance#Subscribe_and_Amend_APIs_to_Migrate), this field has the value of the subscription creation date. * For a subscription changed by an amendment, this field has the value of the amendment booking date. * For a subscription created or changed by an order, this field has the value of the order date. format: date type: string notes: description: | A string of up to 65,535 characters. type: string orderNumber: description: | The order number of the order in which the changes on the subscription are made. **Note:** This field is only available if you have the [Order Metrics](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Order_Metrics) feature enabled. If you wish to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/). We will investigate your use cases and data before enabling this feature for you. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentTerm: description: | The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Term from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string scheduledCancelDate: description: The date when the subscription is scheduled to be canceled. format: date type: string scheduledSuspendDate: description: The date when the subscription is scheduled to be suspended. format: date type: string scheduledResumeDate: description: The date when the subscription is scheduled to be resumed. format: date type: string ratePlans: description: | Container for rate plans. items: $ref: '#/components/schemas/GETSubscriptionRatePlanType' type: array renewalSetting: description: | Specifies whether a termed subscription will remain `TERMED` or change to `EVERGREEN` when it is renewed. Values are: * `RENEW_WITH_SPECIFIC_TERM` (default) * `RENEW_TO_EVERGREEN` type: string renewalTerm: description: | The length of the period for the subscription renewal term. format: int64 type: integer renewalTermPeriodType: description: | The period type for the subscription renewal term. Values are: * `Month` (default) * `Year` * `Day` * `Week` type: string revision: description: | An auto-generated decimal value uniquely tagged with a subscription. The value always contains one decimal place, for example, the revision of a new subscription is 1.0. If a further version of the subscription is created, the revision value will be increased by 1. Also, the revision value is always incremental regardless of deletion of subscription versions. type: string sequenceSetId: description: | The ID of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Set from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body. type: string nullable: true communicationProfileId: default: false description: | The ID of the communication profile associated with the subscription. **Note**: If you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled, this field is unavailable in the request body and the value of this field is `null` in the response body. type: string sequenceSetName: description: | The name of the sequence set associated with the subscription. **Note**: - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null` in the response body. - If you have the Flexible Billing Attributes feature enabled, and you do not specify the `sequenceSetId` field in the request or you select **Default Template from Account** for the `sequenceSetId` field during subscription creation, the value of the `sequenceSetName` field is automatically set to `null` in the response body. type: string serviceActivationDate: description: | The date on which the services or products within a subscription have been activated and access has been provided to the customer, as yyyy-mm-dd format: date type: string shipToContact: $ref: '#/components/schemas/GetAccountSummaryTypeShipToContact' soldToContact: $ref: '#/components/schemas/GETAccountSummaryTypeSoldToContact' status: description: | Subscription status; possible values are: * `Draft` * `Pending Activation` * `Pending Acceptance` * `Active` * `Cancelled` * `Suspended` type: string statusHistory: description: | Container for status history. items: $ref: '#/components/schemas/GETSubscriptionStatusHistoryType' type: array subscriptionEndDate: description: | The date when the subscription term ends, where the subscription ends at midnight the day before. For example, if the `subscriptionEndDate` is 12/31/2016, the subscriptions ends at midnight (00:00:00 hours) on 12/30/2016. This date is the same as the term end date or the cancelation date, as appropriate. format: date type: string subscriptionNumber: description: Subscription number. type: string subscriptionStartDate: description: | Date the subscription becomes effective. format: date type: string success: description: | Returns `true` if the request was processed successfully. type: boolean termEndDate: description: | Date the subscription term ends. If the subscription is evergreen, this is null or is the cancellation date (if one has been set). format: date type: string termStartDate: description: | Date the subscription term begins. If this is a renewal subscription, this date is different from the subscription start date. format: date type: string termType: description: | Possible values are: `TERMED`, `EVERGREEN`. type: string totalContractedValue: description: | Total contracted value of the subscription. type: number version: description: This is the subscription version automatically generated by Zuora Billing. Each order or amendment creates a new version of the subscription, which incorporates the changes made in the order or amendment. format: int64 type: integer type: object - $ref: '#/components/schemas/SubscriptionObjectQTFields' - $ref: '#/components/schemas/SubscriptionObjectNSFields' - $ref: '#/components/schemas/SubscriptionObjectCustomFields' PUTRenewSubscriptionType: example: runBilling: true properties: applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean collect: default: false description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string orderDate: description: | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers. format: date type: string runBilling: default: false description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note**: - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string type: object PUTRenewSubscriptionResponseType: properties: creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoiceId: description: | Invoice ID, if one is generated. type: string paidAmount: description: | Payment amount, if payment is collected. type: number paymentId: description: | Payment ID, if payment is collected. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean termEndDate: description: | Date the new subscription term ends, as yyyy-mm-dd. format: date type: string termStartDate: description: | Date the new subscription term begins, as yyyy-mm-dd. format: date type: string totalDeltaMrr: description: | Change in the subscription monthly recurring revenue as a result of the update. For a renewal, this is the MRR of the subscription in the new term. type: number totalDeltaTcv: description: | Change in the total contracted value of the subscription as a result of the update. For a renewal, this is the TCV of the subscription in the new term. type: number type: object POSTSubscriptionCancellationType: example: cancellationPolicy: EndOfCurrentTerm properties: applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean bookingDate: description: | The booking date that you want to set for the amendment contract when you cancel the subscription. The default value is the current date when you make the API call. format: date type: string cancellationEffectiveDate: description: | Date the cancellation takes effect, in the format yyyy-mm-dd. Use only if `cancellationPolicy` is `SpecificDate`. Should not be earlier than the subscription contract-effective date, later than the subscription term-end date, or within a period for which the customer has been invoiced. format: date type: string cancellationPolicy: description: | Cancellation method. Possible values are: `EndOfCurrentTerm`, `EndOfLastInvoicePeriod`, `SpecificDate`. If using `SpecificDate`, the `cancellationEffectiveDate` field is required. type: string collect: default: false description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean contractEffectiveDate: description: | The date when the customer notifies you that they want to cancel their subscription. format: date type: string creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string orderDate: description: | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers. format: date type: string runBilling: default: false description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: boolean targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note**: - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string required: - cancellationPolicy type: object POSTSubscriptionCancellationResponseType: properties: cancelledDate: description: | The date that the subscription was canceled. This field is available in the Orders Harmonization tenants and the Subscribe and Amend tenants. This field is not available in the Orders tenants. For more information, see Identify your tenant type for managing subscriptions. format: date type: string creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoiceId: description: | ID of the invoice, if one is generated. type: string paidAmount: description: | Amount paid. type: number paymentId: description: | ID of the payment, if a payment is collected. type: string subscriptionId: description: | The subscription ID. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean totalDeltaMrr: description: | Change in the subscription monthly recurring revenue as a result of the update. type: number totalDeltaTcv: description: | Change in the total contracted value of the subscription as a result of the update. type: number type: object PUTSubscriptionResumeType: example: resumePolicy: Today properties: applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean bookingDate: description: | The booking date that you want to set for the amendment contract when you resume the subscription. If `extendsTerm` is `true`, which means you also extend the term, then this field is also the booking date for the Terms and Conditions amendment contract. This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call. format: date type: string collect: default: false description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or a later available version. type: boolean contractEffectiveDate: description: | The date when the customer notifies you that they want to resume their subscription. format: date type: string creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string extendsTerm: description: | Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`. type: boolean orderDate: description: | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers. format: date type: string resumePeriods: description: | The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period. **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. type: string resumePeriodsType: description: | The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriods` field to specify the period. Values: `Day`, `Week`, `Month`, `Year` **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. type: string resumePolicy: description: | Resume methods. Specify a way to resume a subscription. Values: * `Today`: The subscription resumption takes effect on today's date. * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field. * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription. type: string resumeSpecificDate: description: | A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd. **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`. The value should not be earlier than the subscription suspension date. format: date type: string runBilling: default: false description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or a later available version. type: boolean targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. **Note:** - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or a later available version. - The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string required: - resumePolicy type: object PUTSubscriptionResumeResponseType: properties: creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoiceId: description: | Invoice ID, if an invoice is generated during the subscription process. type: string paidAmount: description: | Payment amount, if a payment is collected. type: number paymentId: description: | Payment ID, if a payment is collected. type: string resumeDate: description: | The date when subscription resumption takes effect, as yyyy-mm-dd. format: date type: string subscriptionId: description: | The subscription ID. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean termEndDate: description: | The date when the new subscription term ends, as yyyy-mm-dd. format: date type: string totalDeltaTcv: description: | Change in the total contracted value of the subscription as a result of the update. type: number type: object PUTSubscriptionSuspendType: example: suspendPolicy: Today properties: applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to an invoice. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply to invoices. items: type: string type: array applyCredit: description: | If the value is true, the credit memo or unapplied payment on the order account will be automatically applied to the invoices generated by this order. The credit memo generated by this order will not be automatically applied to any invoices. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: boolean applyCreditBalance: description: | Whether to automatically apply a credit balance to an invoice. If the value is `true`, the credit balance is applied to the invoice. If the value is `false`, no action is taken. To view the credit balance adjustment, retrieve the details of the invoice using the Get Invoices method. Prerequisite: `invoice` must be `true`. **Note:** - If you are using the field `invoiceCollect` rather than the field `invoice`, the `invoiceCollect` value must be `true`. - This field is deprecated if you have the Invoice Settlement feature enabled. type: boolean bookingDate: description: | The booking date that you want to set for the amendment contract when you suspend the subscription. If `resume` is `true`, which means you also choose to resume the subscription at some point, then this field is also the booking date for the Resume amendment contract. This field must be in the `yyyy-mm-dd` format. The default value of this field is the current date when you make the API call. format: date type: string collect: default: false description: | Collects an automatic payment for a subscription. The collection generated in this operation is only for this subscription, not for the entire customer account. If the value is `true`, the automatic payment is collected. If the value is `false`, no action is taken. Prerequisite: The `invoice` or `runBilling` field must be `true`. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `196.0` or a later available version. type: boolean contractEffectiveDate: description: | The date when the customer notifies you that they want to amend their subscription. format: date type: string creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string documentDate: description: | The date of the billing document, in `yyyy-mm-dd` format. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for debit memos. - If this field is specified, the specified date is used as the billing document date. - If this field is not specified, the date specified in the `targetDate` is used as the billing document date. format: date type: string extendsTerm: description: | Whether to extend the subscription term by the length of time the suspension is in effect. Values: `true`, `false`. type: boolean orderDate: description: | The date when the order is signed. If no additinal contractEffectiveDate is provided, this order will use this order date as the contract effective date. This field must be in the `yyyy-mm-dd` format. This field is required for Orders customers only, not applicable to Orders Harmonization customers. format: date type: string resume: description: | Whether to set when to resume a subscription when creating a suspend amendment. Values: `true`, `false`. type: boolean resumePeriods: description: | The length of the period used to specify when the subscription is resumed. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the `resumePeriodsType` field to specify the period. **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. type: string resumePeriodsType: description: | The period type used to define when the subscription resumption takes effect. The subscription resumption takes effect after a specified period based on the suspend date or today's date. You must use this field together with the resumePeriods field to specify the period. Values: `Day`, `Week`, `Month`, `Year` **Note:** This field is only applicable when the `suspendPolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. type: string resumePolicy: description: | Resume methods. Specify a way to resume a subscription. Values: * `Today`: The subscription resumption takes effect on today's date. * `FixedPeriodsFromSuspendDate`: The subscription resumption takes effect after a specified period based on the suspend date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `SpecificDate`: The subscription resumption takes effect on a specific date. You must define the specific date in the `resumeSpecificDate` field. * `FixedPeriodsFromToday`: The subscription resumption takes effect after a specified period based on the today's date. You must specify the `resumePeriods` and `resumePeriodsType` fields to define the period. * `suspendDate`: The subscription resumption takes effect on the date of suspension of the subscription. type: string resumeSpecificDate: description: | A specific date when the subscription resumption takes effect, in the format yyyy-mm-dd. **Note:** This field is only applicable only when the `resumePolicy` field is set to `SpecificDate`. The value should not be earlier than the subscription suspension date. format: date type: string runBilling: default: false description: | Creates an invoice for a subscription. If you have the Invoice Settlement feature enabled, a credit memo might also be created based on the [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). The billing documents generated in this operation is only for this subscription, not for the entire customer account. Possible values: - `true`: An invoice is created. If you have the Invoice Settlement feature enabled, a credit memo might also be created. - `false`: No invoice is created. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or a later available version. type: boolean suspendPeriods: description: | The length of the period used to specify when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the `suspendPeriodsType` field to specify the period. **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. type: string suspendPeriodsType: description: | The period type used to define when the subscription suspension takes effect. The subscription suspension takes effect after a specified period based on today's date. You must use this field together with the suspendPeriods field to specify the period. Type: string (enum) Values: `Day`, `Week`, `Month`, `Year` **Note:** This field is only applicable only when the suspendPolicy field is set to FixedPeriodsFromToday. type: string suspendPolicy: description: | Suspend methods. Specify a way to suspend a subscription. Value: * `Today`: The subscription suspension takes effect on today's date. * `EndOfLastInvoicePeriod`: The subscription suspension takes effect at the end of the last invoice period. The suspend date defaults to a date that is one day after the last invoiced period. You can choose this option to avoid any negative invoices (credits) issued back to the customer after the subscription suspension. * `SpecificDate`: The subscription suspension takes effect on a specific date. You must define the specific date in the `suspendSpecificDate` field. * `FixedPeriodsFromToday`: The subscription suspension takes effect after a specified period based on today's date. You must specify the `suspendPeriods` and `suspendPeriodsType` fields to define the period. type: string suspendSpecificDate: description: | A specific date when the subscription suspension takes effect, in the format yyyy-mm-dd. **Note:** This field is only applicable only when the suspendPolicy field is set to SpecificDate. The value should not be earlier than the subscription contract effective date, later than the subscription term end date, or within a period for which the customer has been invoiced. format: date type: string targetDate: description: | Date through which to calculate charges if an invoice or a credit memo is generated, as yyyy-mm-dd. Default is current date. This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `211.0` or a later available version. **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string required: - suspendPolicy type: object PUTSubscriptionSuspendResponseType: properties: creditMemoId: description: | The credit memo ID, if a credit memo is generated during the subscription process. **Note:** This container is only available if you set the Zuora REST API minor version to 207.0 or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) in the request header, and 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. type: string invoiceId: description: | Invoice ID, if an invoice is generated during the subscription process. type: string paidAmount: description: | Payment amount, if a payment is collected. type: number paymentId: description: | Payment ID, if a payment is collected. type: string resumeDate: description: | The date when subscription resumption takes effect, in the format yyyy-mm-dd. format: date type: string nullable: true subscriptionId: description: | The subscription ID. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean suspendDate: description: | The date when subscription suspension takes effect, in the format yyyy-mm-dd. format: date type: string termEndDate: description: | The date when the new subscription term ends, in the format yyyy-mm-dd. format: date type: string totalDeltaTcv: description: | Change in the total contracted value of the subscription as a result of the update. type: number type: object PUTDeleteSubscriptionResponseType: properties: success: description: Returns `true` if the request is processed successfully. type: boolean type: object PUTSubscriptionPatchSpecificVersionRequestType: example: customFields: CustomTag__c: internal properties: customFields: $ref: '#/components/schemas/SubscriptionObjectCustomFields' ratePlans: items: properties: charges: items: properties: chargeId: description: | Use either this field or the `chargeNumber` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify a specific charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments. type: string chargeNumber: description: | Use either this field or the `chargeId` field to specify the charge for which you will be updating the custom fields. By using this field you actually specify the last charge segment of a charge. See [Segmented rate plan charges](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/RatePlanCharge#Segmented_rate_plan_charges) for more information about charge segments. type: string customFields: $ref: '#/components/schemas/RatePlanChargeObjectCustomFields' type: object type: array customFields: $ref: '#/components/schemas/RatePlanObjectCustomFields' ratePlanId: description: The rate plan id in any version of the subscription. This will be linked to the only one rate plan in the current version. type: string required: - ratePlanId type: object type: array type: object GETMetricsBySubscriptionNumbersResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: subscriptionMetrics: items: properties: subscriptionNumber: description: | The number for the subscription. type: string contractedMrr: description: | Monthly recurring revenue of the subscription. type: number contractedNetMrr: description: | Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number asOfDayGrossMrr: description: | Monthly recurring revenue of the subscription rate plan exclusive of any discounts applicable as of specified day. type: number asOfDayNetMrr: description: | Monthly recurring revenue of the subscription rate plan inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts as of specified day. type: number netTotalContractedValue: description: | Total contracted value of the subscription inclusive of all the discounts applicable, including the fixed-amount discounts and percentage discounts. type: number totalContractedValue: description: | Total contracted value of the subscription. type: number type: object type: array type: object POSTReverseRolloverRequestType: allOf: - properties: destinationValidityPeriod: $ref: '#/components/schemas/DestinationValidityPeriodInfo' prepaymentUom: description: | Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Values**: a valid unit of measure type: string sourceValidityPeriod: $ref: '#/components/schemas/SourceValidityPeriodInfo' subscriptionNumber: description: The unique identifier number of the subscription. maxLength: 100 type: string required: - subscriptionNumber - prepaymentUom - sourceValidityPeriod - destinationValidityPeriod type: object example: destinationValidityPeriod: endDate: '2024-01-01' startDate: '2023-01-01' prepaymentUom: Each sourceValidityPeriod: endDate: '2025-01-01' startDate: '2024-01-01' subscriptionNumber: A-S00000009 POSTReverseRolloverResponseType: properties: message: description: Indicates the result. type: string reverseRolloverFundCount: description: Indicates the number of funds which have been rolled back. format: int64 type: integer success: description: Indicates whether the call succeeded. type: boolean type: object DestinationValidityPeriodInfo: description: Date range of the destination validity period to which the funds are transferred. It should be close to the source validity period. properties: endDate: description: End date of the destination validity period. format: date type: string startDate: description: Start date of the destination validity period. format: date type: string required: - startDate - endDate title: destinationValidityPeriod type: object SourceValidityPeriodInfo: description: Date range of the source validity period from which the funds are transferred. It should be close to the destination validity period. properties: endDate: description: End date of the source validity period. format: date type: string startDate: description: Start date of the source validity period. format: date type: string required: - startDate - endDate title: sourceValidityPeriod type: object POSTTriggerRolloverRequestType: allOf: - properties: destinationValidityPeriod: $ref: '#/components/schemas/DestinationValidityPeriodInfo' prepaymentUom: description: | Specifies the units of measure for prepayment charge. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Values**: a valid unit of measure type: string priority: description: | Specifies the priority of rolled over fund in case of drawdown. **Values**: ApplyLast / ApplyFirst type: string sourceValidityPeriod: $ref: '#/components/schemas/SourceValidityPeriodInfo' subscriptionNumber: description: The unique identifier number of the subscription. maxLength: 100 type: string required: - subscriptionNumber - prepaymentUom - sourceValidityPeriod - destinationValidityPeriod - priority type: object example: destinationValidityPeriod: endDate: '2025-01-01' startDate: '2024-01-01' prepaymentUom: Each priority: ApplyFirst sourceValidityPeriod: endDate: '2024-01-01' startDate: '2023-01-01' subscriptionNumber: A-S00000009 POSTTriggerRolloverResponseType: properties: message: description: Indicates the result. type: string rolloverFundCount: description: Indicates the number of funds which have been rolled over. format: int64 type: integer success: description: Indicates whether the call succeeded. type: boolean type: object POSTDepleteFundRequestType: properties: fundIds: description: | The unique ID of the fund. A maximum of 100 fund Ids are allowed. type: object example: fundIds: - 4028818c8d0c9db5018d0cbbdecd72c1 - 4028818c8d0c9db5018d0cbbdecd72c2 POSTDepleteFundResponseType: properties: fundIds: items: properties: fundId: description: | The unique ID of the fund. type: string status: description: | The status of the fund expiry. type: string message: description: | The detail information of the fund expiry response. type: string type: object type: array type: object POSTUsageResponseType: properties: checkImportStatus: description: | The path for checking the status of the import. The possible status values at this path are `Pending`, `Processing`, `Completed`, `Canceled`, and `Failed`. Only `Completed` indicates that the file contents were imported successfully. type: string size: description: | The size of the uploaded file in bytes. format: int64 type: integer success: description: | Indicates whether the call succeeded. type: boolean type: object GETUsageRateDetailWrapper: properties: data: description: | Contains usage rate details for the invoice item as specified in the request. properties: amountWithoutTax: description: | The amount of the invoice item without tax. format: double type: number chargeNumber: description: | The unique number of the product rate plan charge associated with the invoice item. type: string invoiceId: description: | The unique ID of the invoice. type: string invoiceItemId: description: | The unique ID of the invoice item. type: string invoiceNumber: description: | The unique number of the invoice. type: string listPrice: description: | The list price of the product rate plan charge associated with the invoice item. For example, if the product rate plan charge uses the tiered charge model, its list price could be: Tier / From / To / List Price / Price Format\n1 / 0 / 9 / 0.00 / Per Unit\n2 / 10 / 20 / 1.00 / Per Unit\n3 / 21 / 30 / 2.00 / Flat Fee\n4 / 31 / / 3.00 / Per Unit\n type: string quantity: description: | The quantity of the invoice item. format: double type: number rateDetail: description: | The rate detail of the invoice item. It shows how the total amount is calculated. For example, if the product rate plan charge uses the tiered charge model, the rate detail for the associated invoice item could be: Tier 1: 0-9, 9 Each(s) x $0.00/Each = $0.00\nTier 2: 10-20, 11 Each(s) x $1.00/Each = $11.00\nTier 3: 21-30, $2.00 Flat Fee\nTier 4: >=31, 15 Each(s) x $3.00/Each = $45.00\nTotal = $58.00. The rate detail retrieved from this REST API operation is the same as the [Rate Detail presented on PDF invoices](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Create_a_custom_invoice_template/DD_Display_Usage_Charge_Breakdown#How_UsageSummary.RateDetail_is_displayed_on_invoices). type: string servicePeriod: description: | The service period of the invoice item. type: string uom: description: | The unit of measurement of the invoice item. type: string type: object success: description: | Returns `true` if the request was processed successfully. Returns `false` if the request was not processed successfully. type: boolean type: object ProxyCreateUsage: allOf: - properties: AccountId: description: |2- The ID of the account associated with the usage data. This field is only required if no value is specified for the `AccountNumber` field. **Character limit**: 32 **Values**: a valid account ID. type: string AccountNumber: description: |2- The number of the account associated with the usage data. This field is only required if no value is specified for the `AccountId` field. **Character limit**: 50 **Values**: a valid account number. type: string ChargeId: description: ' The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID. ' type: string ChargeNumber: description: | A unique number for the rate plan charge related to the usage record. For example, C-00000007. maxLength: 50 type: string Description: description: | A description of the usage record. maxLength: 200 type: string EndDateTime: description: |2- The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value. format: date-time type: string ProductRatePlanChargeNumber: description: | Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `146` or higher. Otherwise, an error occurs. **Note**: This field is only available if you have the Dynamic Usage Charges feature enabled. type: string Quantity: description: | Indicates the number of units used. **Character limit**: 16 **Values**: A valid decimal amount. format: double type: number StartDateTime: description: |2- The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value format: date-time type: string SubscriptionId: description: | The original ID of the subscription that contains the fees related to the usage data. The ID of a subscription might change when you create amendments to the subscription. It is good practice to use the unique subscription number that you can specify in the `SubscriptionNumber` field. maxLength: 32 type: string SubscriptionNumber: description: | The unique identifier number of the subscription that contains the fees related to the usage data. It is good practice to use this field when creating usage records. maxLength: 100 type: string UOM: description: | Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Character limit**: **Values**: a valid unit of measure type: string UniqueKey: description: | The unique external reference of the usage record. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Bill_for_usage_or_prepaid_products/Advanced_Consumption_Billing/Unbilled_Usage#Upload_usage_record_with_unique_key) for information on how to use this field. **Note**: This field is only available if you set the `X-Zuora-WSDL-Version` request header to `114` or later. This field is only available if you have the Prepaid with Drawdown feature or the Unbilled Usage feature enabled. See [Upload usage record with unique key](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Prepaid_balance_transactions#Upload_usage_record_with_unique_key) for more information. type: string required: - Quantity - StartDateTime - UOM type: object - $ref: '#/components/schemas/UsageObjectCustomFields' example: AccountId: 8ad09378905a5af201907ca1edb524c2 UOM: Minutes Quantity: 200 StartDateTime: '2024-06-01T02:00:00.000+01:00' UsageObjectCustomFields: additionalProperties: description: | Custom fields of the Usage object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Usage object. title: usageFieldsCustom type: object ProxyGetUsage: allOf: - properties: AccountId: description: |2- The ID of the account associated with the usage data. This field is required if no value is specified for the `AccountNumber` field. **Character limit**: 32 **Values**: a valid account ID type: string AccountNumber: description: |2- The number of the account associated with the usage data. This field is required if no value is specified for the `AccountId` field. **Character limit**: 50 **Values**: a valid account number type: string ChargeId: description: ' The OrginalId of the rate plan charge related to the usage record, e.g., `2c9081a03c63c94c013c6873357a0117` **Character limit**: 32 **Values**: a valid rate plan charge OriginalID ' type: string CreatedById: description: |2- The user ID of the person who uploaded the usage records. **Character limit**: 32 **Values**: automatically generated type: string CreatedDate: description: |2- The date when the usage was generated. **Character limit**: 29 **Values**: automatically generated format: date-time type: string Description: description: | A description of the usage record. type: string EndDateTime: description: |2- The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value format: date-time type: string Id: description: Object identifier. type: string ProductRatePlanChargeNumber: description: | Specify a product rate plan charge number so that you can charge your customer with a dynamic usage charge for the corresponding uploaded usage record. To use this field, you must set the `X-Zuora-WSDL-Version` request header to `146` or higher. Otherwise, an error occurs. **Note**: This field is only available if you have the Dynamic Usage Charges feature enabled. type: string Quantity: description: | Indicates the number of units used. **Character limit**: 16 **Values**: A valid decimal amount. format: double type: number RbeStatus: description: |2- Indicates if the rating and billing engine (RBE) processed usage data for an invoice. **Character limit**: 9 **Values**: automatically generated to be one of the following values: `Importing`, `Pending`, `Processed` type: string SourceType: description: |2- Indicates if the usage records were imported from the web-based UI or the API. **Character limit**: 6 **Values**: automatically generated to be one of the following values: `API`, `Import` type: string StartDateTime: description: |2- The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value format: date-time type: string SubscriptionId: description: |2- The original ID of the subscription that contains the fees related to the usage data. **Character limit**: 32 **Values**: a valid subscription ID type: string SubscriptionNumber: description: | The unique identifier number of the subscription that contains the fees related to the usage data. type: string UOM: description: |2- Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Character limit**: **Values**: a valid unit of measure type: string UpdatedById: description: |2- The ID of the user who last updated the usage upload. **Character limit**: 32 **Values**: automatically generated type: string UpdatedDate: description: |2- The date when the usage upload was last updated. **Character limit**: 29 **Values**: automatically generated format: date-time type: string type: object - $ref: '#/components/schemas/UsageObjectCustomFields' ProxyModifyUsage: allOf: - properties: EndDateTime: description: |2- The end date and time of a range of time when usage is tracked. Use this field for reporting; this field doesn't affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value format: date-time type: string Quantity: description: | Indicates the number of units used. **Character limit**: 16 **Values**: A valid decimal amount. format: double type: number RbeStatus: description: |2- Indicates if the rating and billing engine (RBE) processed usage data for an invoice. **Character limit**: 9 **Values**: automatically generated to be one of the following values: `Importing`, `Pending`, `Processed` type: string StartDateTime: description: |2- The start date and time of a range of time when usage is tracked. Zuora uses this field value to determine the usage date. Unlike the `EndDateTime`, the `StartDateTime` field does affect usage calculation. **Character limit**: 29 **Values**: a valid date and time value format: date-time type: string UOM: description: |2- Specifies the units to measure usage. Units of measure are configured in the web-based UI. Your values depend on your configuration in **Billing Settings**. **Character limit**: **Values**: a valid unit of measure type: string type: object - $ref: '#/components/schemas/UsageObjectCustomFields' example: EndDateTime: '2024-06-30T02:00:00.000+01:00' GETAdjustmentsBySubscriptionNumberResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: adjustments: description: | Container for all the delivery adjustments of a subscription. items: $ref: '#/components/schemas/GETAdjustmentByIdResponseType' type: array type: object GETAdjustmentByIdResponseType: allOf: - properties: adjustmentId: description: | The system generated delivery adjustment ID. format: UUID type: string adjustmentNumber: description: | The system generated delivery adjustment Number. type: string amount: description: | The amount of the delivery adjustment. type: number billingDate: description: | The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format. format: date type: string chargeNumber: description: | The charge number in the subscription for which the delivery adjustment is created. type: string creditMemoNumber: description: | The Credit Memo generated for the delivery adjustment. type: string debitMemoNumber: description: | The Debit Memo generated to write off the Credit Memo for the delivery adjustment. **Note**: This field is only available when the delivery adjustment is in `Cancelled` status. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string deliveryDate: description: | The delivery adjustment date, in `yyyy-mm-dd` format. format: date type: string deliveryDay: description: | The delivery adjustment day of the week. format: string type: string reason: description: | The reason for the delivery adjustment. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string status: description: | The status of the delivery adjustment will be `Billed` or `Cancelled`. type: string subscriptionNumber: description: | The subscription number for which the delivery adjustment is created. type: string type: object POSTCreateBillingAdjustmentRequestType: example: chargeNumbers: - string - string deferredRevenueAccountingCode: string endDate: '2023-02-27' exclusion: - chargeNumbers: - string - string deliveryDate: '2023-02-26' - chargeNumbers: - string - string deliveryDate: '2023-05-27' reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string startDate: '2023-02-26' subscriptionNumber: string type: DeliveryCredit properties: accountNumber: description: | The account number for which the delivery adjustment is created. **Note**: - The account number should be of the subscription owner. - Only one of accountNumber or subscriptionNumber should be provided. type: string chargeNumbers: description: | An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created. items: type: string type: array deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string endDate: description: | The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. format: date type: string exclusion: description: | The charge numbers and the corresponding dates for exclusion of delivery adjustment. items: properties: chargeNumbers: description: | The charge numbers to be excluded from delivery adjustment on the specified delivery date. items: type: string type: array deliveryDate: description: | The date on which the delivery adjustment has to be excluded, in `yyyy-mm-dd` format. format: date type: string type: object type: array reason: description: | The reason for the delivery adjustment. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string startDate: description: | The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. format: date type: string subscriptionNumber: description: | The subscription number for which the delivery adjustment is created. **Note**: Only one of accountNumber or subscriptionNumber should be provided. type: string type: description: | The type of delivery adjustment. enum: - DeliveryCredit type: string creditMemoCustomFields: additionalProperties: description: | Custom fields of the Credit Memo object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Manage Custom Fields for more information. type: object description: | Container for custom fields of the Credit Memo object. When creating a delivery adjustment, Zuora generates a credit memo automatically. You can use this field to specify the custom fields of the credit memo associated with this adjustment. title: creditMemoCustomFields type: object required: - startDate - endDate type: object GETAdjustmentsResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: adjustments: description: | Container for delivery adjustments of a subscription. items: $ref: '#/components/schemas/POSTAdjustmentResponseType' type: array ineligibleAdjustments: description: | Container for ineligible delivery adjustments of a subscription. items: $ref: '#/components/schemas/POSTIneligibleAdjustmentResponseType' type: array totalAmount: description: | The total amount of all the delivery adjustments. type: number totalNumberOfDeliveries: description: | The total number of all delivery adjustments. type: number type: object POSTAdjustmentResponseType: allOf: - properties: adjustmentId: description: | The system generated delivery adjustment ID. format: UUID type: string adjustmentNumber: description: | The system generated delivery adjustment number. format: string type: string amount: description: | The amount of the delivery adjustment. type: number billingDate: description: | The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format. format: date type: string chargeNumber: description: | The charge number in the subscription for which the delivery adjustment is created. type: string creditMemoNumber: description: | The Credit Memo generated for the delivery adjustment. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string deliveryDate: description: | The delivery adjustment date, in `yyyy-mm-dd` format. format: date type: string deliveryDay: description: | The delivery adjustment day of the week. type: string eligible: description: | The eligible flag is set as true for a successfully created delivery adjustment. type: boolean reason: description: | The reason for the delivery adjustment. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string status: description: | The status of the delivery adjustment will be `Billed` or `Cancelled`. type: string subscriptionNumber: description: | The subscription number for which the delivery adjustment is created. type: string type: object POSTIneligibleAdjustmentResponseType: allOf: - properties: adjustmentId: description: | The system generated delivery adjustment ID. format: UUID type: string adjustmentNumber: description: | The system generated delivery adjustment number. format: string type: string amount: description: | The amount of the delivery adjustment. type: number billingDate: description: | The billing date of the delivery adjustment. format: date type: string chargeNumber: description: | The charge number in the subscription for which the delivery adjustment is created. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string deliveryDate: description: | The delivery adjustment date, in `yyyy-mm-dd` format. format: date type: string deliveryDay: description: | The delivery adjustment day of the week. format: string type: string eligible: description: | The eligible flag is set as false for an unsuccessful delivery adjustment. type: boolean errorMessage: description: | The reason due to which a delivery adjustment is not eligible on the given date. type: string reason: description: | The reason for the delivery adjustment. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string status: description: | The status of the delivery adjustment. type: string subscriptionNumber: description: | The subscription number for which the delivery adjustment is created. type: string type: object POSTPreviewBillingAdjustmentRequestType: example: chargeNumbers: - string - string deferredRevenueAccountingCode: string endDate: '2023-02-27' exclusion: - chargeNumbers: - string - string deliveryDate: '2023-02-26' - chargeNumbers: - string - string deliveryDate: '2023-05-27' reason: string recognizedRevenueAccountingCode: string revenueRecognitionRuleName: string startDate: '2023-02-26' subscriptionNumber: string type: DeliveryCredit properties: accountNumber: description: | The account number for which the delivery adjustment is created. **Note**: - The account number should be of the subscription owner. - Only one of accountNumber or subscriptionNumber should be provided. type: string chargeNumbers: description: | An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created. items: type: string type: array deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string endDate: description: | The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. format: date type: string reason: description: | The reason for the delivery adjustment. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note**: For the credit memo generated by the delivery adjustment, if this field is not specified, the value inherits from the subscription rate plan charge. type: string startDate: description: | The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive. format: date type: string subscriptionNumber: description: | The subscription number for which the delivery adjustment is created. **Note**: Only one of accountNumber or subscriptionNumber should be provided. type: string type: description: | The type of delivery adjustment. enum: - DeliveryCredit type: string required: - startDate - endDate type: object CancelBillingAdjustmentRequest: example: debitMemoCustomFields: trackingNumber__c: '001' description: | Information about `CancelBillingAdjustment`. properties: debitMemoCustomFields: additionalProperties: description: | Custom fields of the Debit Memo object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Manage Custom Fields for more information. type: object description: | Container for custom fields of the Debit Memo object. When cancelling a delivery adjustment, Zuora generates a debit memo automatically. You can use this field to specify the custom fields of the debit memo associated with the cancellation of adjustment. title: debitMemoCustomFields type: object GETCancelAdjustmentResponseType: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: debitMemoNumber: description: | The Debit Memo generated to write off the Credit Memo for the delivery adjustment. type: string type: object BillingDocumentQueryResponseElementType: properties: documents: description: | Container for billing documents. items: $ref: '#/components/schemas/GETBillingDocumentsResponseType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETBillingDocumentsResponseType: properties: accountId: description: The ID of the customer account associated with the billing document. format: uuid type: string amount: description: | The total amount of the billing document. format: double type: number balance: description: | The balance of the billing document. format: double type: number documentDate: description: | The date of the billing document. The date can be the invoice date for invoices, credit memo date for credit memos, or debit memo date for debit memos. format: date type: string documentNumber: description: | The number of the billing document. type: string documentType: description: | The type of the billing document. enum: - Invoice - CreditMemo - DebitMemo type: string id: description: | The ID of the billing document. type: string status: description: | The current status of the billing document. enum: - Draft - Posted - Canceled - Error type: string currency: description: | The currency of the billing document. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. type: string nullable: true title: documents type: object POSTBillingDocumentFilesDeletionJobRequest: example: accountIds: - 4028905558b483220158b48983dd0015 - 6028905558b483220158b68983dd0016 properties: accountIds: description: | Container for the IDs of the accounts that you want to create the billing document files deletion job for. **Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body. items: type: string type: array accountKeys: description: | Container for the IDs and/or numbers of the accounts that you want to create the billing document files deletion job for. **Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body. items: type: string type: array type: object POSTBillingDocumentFilesDeletionJobResponse: properties: id: description: | The unique ID of the billing document file deletion job. type: string status: description: | The status of the billing document file deletion job. enum: - Pending type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETBillingDocumentFilesDeletionJobResponse: properties: id: description: | The unique ID of the billing document file deletion job. type: string status: description: | The status of the billing document file deletion job. enum: - Pending - Processing - Completed - Error type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object PostGenerateBillingDocumentType: example: subscriptionIds: - 8ad09be490a1ec6a0190a56eb69d4cd3 effectiveDate: '2024-07-01' targetDate: '2024-08-31' properties: autoPost: default: false description: | Whether to automatically post the billing documents after the draft billing documents are generated. If an error occurs during posting billing documents, the draft billing documents are not generated too. enum: - true - false type: boolean autoRenew: default: false description: | Whether to automatically renew the subscriptions with **Auto Renew** set to **Yes**. enum: - true - false type: boolean chargeTypeToExclude: description: | The types of the charges to be excluded from the generation of billing documents. The field values are case insensitive. Supported values include `onetime`, `recurring`, and `usage`. items: type: string type: array creditMemoReasonCode: description: A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code. type: string effectiveDate: description: | The date on which to generate the billing documents, in `yyyy-mm-dd` format. format: date type: string includeSubscriptions: default: true description: | Indicates whether to bill subscriptions in the bill run. type: boolean includeOrderLineItems: default: true description: | Indicates whether to bill order line items in the bill run. type: boolean subscriptionIds: description: | The IDs of the subscriptions that you want to create the billing documents for. Each value must be the ID of the latest version of an active subscription. items: type: string type: array targetDate: description: | The date used to determine which charges are to be billed, in `yyyy-mm-dd` format. format: date type: string type: object GenerateBillingDocumentResponseType: properties: creditMemos: description: | Container for generated credit memos. **Note:** This container 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. items: $ref: '#/components/schemas/CreditMemoResponseType' type: array invoices: description: | Container for generated invoics. items: $ref: '#/components/schemas/InvoiceResponseType' type: array success: description: Returns `true` if the request was processed successfully. type: boolean type: object CreditMemoResponseType: properties: id: description: | The ID of the generated credit memo. type: string title: creditMemos type: object InvoiceResponseType: properties: id: description: | The ID of the generated invoice. type: string title: invoices type: object PostInvoiceType: allOf: - properties: accountId: description: | The ID of the account associated with the invoice. You must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account. type: string accountNumber: description: | The Number of the account associated with the invoice. You must specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account. type: string autoPay: default: false description: | Whether invoices are automatically picked up for processing in the corresponding payment run. type: boolean billToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' billToContactId: description: | The ID of the bill-to contact associated with the invoice. This field is mutually exclusive with the `billToContact` field. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string comments: description: | Comments about the invoice. type: string currency: description: | The code of a currency as defined in Billing Settings through the Zuora UI. If you do not specify a currency during standalone invoice creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both). **Note**: - This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. - Invoice, InvoiceItem, and TaxationItem will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency. items: $ref: '#/components/schemas/InvoiceWithCustomRatesType' maxItems: 2 type: array dueDate: description: | The date by which the payment for this invoice is due, in `yyyy-mm-dd` format. format: date type: string invoiceDate: description: | The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period. format: date type: string invoiceItems: description: | Container for invoice items. The maximum number of invoice items is 1,000. You must have corresponding billing permissions to create invoice items from existing product rate plan charges or new charges. For more information about billing permissions, see Billing Roles. - To create an invoice item from an existing charge, you must have the **Create Standalone Invoice With Product Catalog** permission and specify the charge ID in the `productRatePlanChargeId` field. - To create an invoice item from a new charge, you must have the **Create Standalone Invoice Without Product Catalog** permission without specifying the `productRatePlanChargeId` field. **Note**: For the "Create a standalone invoice" and "Create standalone invoices" operations, note the following: - If tax has been calculated by an external tax engine, you need to create a standalone invoice with both `invoiceItems` and `taxItems`. The `taxItems` corresponds to the tax information processed by this external tax engine. In this case, you should not specify the `taxMode` and `taxCode` nested fields of the `invoiceItems` field. Instead, you need to specify the `taxMode` and `taxCode` nested fields of the `taxItems` field. You need to specify the `taxMode` field as `TaxExclusive`. - If tax has not been calculated by an external tax engine, you can create a standalone invoice only with `invoiceItems`, and decide whether Zuora includes the tax in the quoted charge price and invoice item by specifying the `taxMode` nested field of the `invoiceItems` field as either `TaxExclusive` or `TaxInclusive`. Meanwhile, you need to specify the `taxCode` field, indicating the charge price and invoice item are taxable. items: $ref: '#/components/schemas/PostInvoiceItemType' type: array invoiceNumber: description: | A customized invoice number with the following format requirements: - Max length: 32 characters - Acceptable characters: a-z,A-Z,0-9,-,_, Purely numerical prefixes or prefixes ending with a number are supported for standalone invoices. For example, you can use `202310000300`, `2003`, `INV202310000300`, or `2023-09-100009785` as invoice numbers. The value must be unique in the system, otherwise it may cause issues with bill runs and subscribe/amend. Check out [things to note and troubleshooting steps](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Unified_Invoicing/Import_external_invoices_as_standalone_invoices?#Customizing_invoice_number). type: string paymentTerm: description: | The ID or name of the payment term associated with the invoice. For example, `Net 30`. The payment term determines the due dates of invoices. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string sequenceSet: description: | The ID or name of the sequence set associated with the invoice. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string shipToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' shipToContactId: description: | The ID of the ship-to contact associated with the invoice. This field is mutually exclusive with the `shipToContact` field. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string shipToSameAsBillTo: default: false description: | Whether the ship-to contact and bill-to contact are the same entity. This field is mutually exclusive with the `shipToContact` and `shipToContactId` fields. The created invoice has the same bill-to contact and ship-to contact entity only when all the following conditions are met in the request body: - This field is set to `true`. - A bill-to contact or bill-to contact ID is specified. - Neither ship-to contact nor ship-to contact ID is specified. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: boolean soldToContact: $ref: '#/components/schemas/PostCreateInvoiceContactType' soldToContactId: description: | The ID of the sold-to contact associated with the invoice. This field is mutually exclusive with the `soldToContact` field. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string soldToSameAsBillTo: default: false description: | Whether the sold-to contact and bill-to contact are the same entity. This field is mutually exclusive with the `soldToContact` and `soldToContactId` fields. The created invoice has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body: - This field is set to `true`. - A bill-to contact or bill-to contact ID is specified. - Neither sold-to contact nor sold-to contact ID is specified. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: boolean status: default: Draft description: | The status of invoice. By default, the invoice status is Draft. When creating an invoice, if you set this field to `Posted`, the invoice is created and posted directly. enum: - Draft - Posted type: string templateId: description: | The ID of the invoice template associated with the invoice. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. type: string transferredToAccounting: enum: - Processing - Error - Ignore - 'Yes' - 'No' type: string required: - invoiceDate title: invoices type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' example: accountId: 8ad09be48db5aba7018db604776d4854 invoiceDate: '2024-07-30' invoiceItems: - amount: 100 serviceStartDate: '2024-07-11' productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 PostInvoiceResponse: allOf: - properties: accountId: description: | The ID of the customer account associated with the invoice. type: string adjustmentAmount: description: | The amount of the invoice adjustments associated with the invoice. type: number amount: description: | The total amount of the invoice. type: number amountWithoutTax: description: | The invoice amount excluding tax. type: number autoPay: description: | Whether invoices are automatically picked up for processing in the corresponding payment run. type: boolean balance: description: | The remaining balance of the invoice after all payments, adjustments, and refunds are applied. type: number billRunId: description: | The id of bill run if the invoice is generated by a bill run. type: string billToContactId: description: | The ID of the bill-to contact associated with the invoice. type: string nullable: true billToContactSnapshotId: description: | The ID of the bill-to contact snapshot associated with the invoice. type: string comments: description: | Comments about the invoice. type: string createdById: description: | The user ID of the person who created the invoice. If a bill run generated the invoice, then the value is the user ID of person who created the bill run. type: string createdDate: description: | The date and time when the invoice was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditBalanceAdjustmentAmount: description: | The currency amount of the adjustment applied to the customer's credit balance. **Note:** This field is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. type: number creditMemoAmount: description: | The currency amount of all credit memos applied to this invoice. **Note:** This field is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. type: number currency: description: | The currency of the invoice. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. nullable: true type: string discount: description: | the invoice discount amount. type: number dueDate: description: | The date by which the payment for this invoice is due, in `yyyy-mm-dd` format. format: date type: string einvoiceErrorCode: description: | The error code when status is "Failed". This code can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor. type: string einvoiceErrorMessage: description: | The error message when status is "Failed". This message can either be a Zuora-generated error code or one returned by a third-party e-invoice vendor. type: string einvoiceFileId: description: | The ID of the e-invoice file. type: string einvoiceStatus: description: | The status of the e-invoice file generation for the invoice. - If e-invoicing file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceField` fieldstores the ID of the generated e-inoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string id: description: | The unique ID of the invoice. type: string includesOneTime: description: | Specifies whether the invoice includes one-time charges. type: boolean includesRecurring: description: | Specifies whether the invoice includes recurring charges. type: boolean includesUsage: description: | Specifies whether the invoice includes usage charges. type: boolean invoiceDate: description: | The date that appears on the invoice being created. format: date type: string invoiceGroupNumber: description: | The number of the invoice group associated with the invoice. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true invoiceNumber: description: | The unique identification number of the invoice. type: string lastEmailSentDate: description: | The date when the invoice was last emailed. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentAmount: description: | The amount of payments applied to the invoice. type: number paymentTerm: description: | The name of payment term associated with the invoice. type: string nullable: true postedBy: description: | The user ID of the person who moved the invoice to Posted status. type: string postedDate: description: | The date when the invoice was posted. format: date type: string refundAmount: description: | Specifies the amount of a refund that was applied against an earlier payment on the invoice. type: number sequenceSetId: description: | The ID of the sequence set associated with the invoice. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the invoice. type: string nullable: true shipToContactId: description: | The ID of the ship-to contact associated with the invoice. type: string nullable: true shipToContactSnapshotId: description: | The ID of the ship-to contact snapshot associated with the invoice. type: string soldToContactId: description: | The ID of the sold-to contact associated with the invoice. type: string nullable: true soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the invoice. type: string source: description: | The source of the invoice. enum: - BillRun - API - ApiSubscribe - ApiAmend type: string sourceId: description: | The ID of the invoice source. If an invoice is generated from a bill run, the value is the number of the corresponding bill run.Otherwise, the value is `null`. type: string sourceType: description: | The type of the invoice source. enum: - Subscription - Standalone - Order - Consolidation type: string status: description: | The status of the invoice. enum: - Draft - Posted type: string success: description: Returns `true` if the request was processed successfully. type: boolean targetDate: description: | This date is used to determine which charges are to be billed. All charges that are to be billed on this date or prior will be included in this bill run. format: date type: string taxAmount: description: | The amount of taxation. type: number taxExemptAmount: description: | The calculated tax amount excluded due to the exemption. type: number taxMessage: description: | The message that the tax engine return if it calculates the taxes of this invoice fails. type: string nullable: true taxStatus: description: | The status that the tax engine return after it calculates the taxes of this invoice. **Note:** This field is only applicable to tax calculation by third-party tax engines. The `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string templateId: description: | The ID of the invoice template. - If you have the Flexible Billing Attributes feature enabled, the value of this field depends on the configuration of the invoice template. - If you specify an invoice template at the subscription level, the value of this field is automatically populated from the corresponding subscription. - If you do not specify any invoice template at the subscription level, the value of this field is automatically populated from the corresponding account. - If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string nullable: true transferredToAccounting: description: | Whether the invoice was transferred to an external accounting system. enum: - Processing - Error - Ignore - 'Yes' - 'No' type: string updatedById: description: | The ID of the Zuora user who last updated the invoice. type: string updatedDate: description: | The date when the invoice was last updated. format: date-time type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' InvoiceObjectNSFields: description: | Container for Invoice fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the invoice's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the invoice was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: invoiceFieldsNS type: object InvoiceObjectCustomFields: additionalProperties: description: | Custom fields of the Invoice object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Invoice object. title: invoiceFieldsCustom type: object PostCreateInvoiceContactType: allOf: - properties: address1: description: | First address line, 255 characters or less. maxLength: 255 type: string address2: description: | Second address line, 255 characters or less. type: string city: description: | City, 40 characters or less. maxLength: 40 type: string country: description: | Country; must be a valid country name or abbreviation. If using Zuora Tax, you must specify a country in the ship-to or sold-to contact to calculate tax. A bill-to contact may be used if no ship-to or sold-to contact is provided. type: string county: description: | County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax. maxLength: 32 type: string fax: description: | Fax phone number, 40 characters or less. maxLength: 40 type: string firstName: description: | First name, 100 characters or less. maxLength: 100 type: string homePhone: description: | Home phone number, 40 characters or less. maxLength: 40 type: string lastName: description: | Last name, 100 characters or less. maxLength: 100 type: string mobilePhone: description: | Mobile phone number, 40 characters or less. maxLength: 40 type: string nickname: description: | Nickname for this contact type: string otherPhone: description: | Other phone number, 40 characters or less. maxLength: 40 type: string otherPhoneType: description: | Possible values are: `Work`, `Mobile`, `Home`, `Other`. type: string personalEmail: description: | Personal email address. maxLength: 80 type: string format: email state: description: | State; must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. If using Zuora Tax, be aware that Zuora Tax requires a state (in the US) or province (in Canada) in this field for the ship-to or sold-to contact to calculate tax, and that a bill-to contact may be used if no ship-to or sold-to contact is provided. type: string taxRegion: description: | If using Zuora Tax, a region string as optionally defined in your tax rules. Not required. type: string workEmail: description: | Work email address, 80 characters or less. maxLength: 80 type: string workPhone: description: | Work phone number, 40 characters or less. maxLength: 40 type: string zipCode: description: | Zip code, 20 characters or less. maxLength: 20 type: string required: - firstName - lastName type: object - $ref: '#/components/schemas/ContactCustomFields' description: | Container for bill-to, sold-to, or ship-to contact information. A new Contact will be created under the invoice owner account. **Note**: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body. title: Contact InvoiceWithCustomRatesType: allOf: - properties: currency: description: | The currency code for either Reporting or Home currency. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or later. type: string customFxRate: description: | The Custom FX conversion rate between Home/Reporting and Transactional currency items. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or later. format: decimal type: number rateDate: description: | The date on which a particular currency rate is fixed or obtained on. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or later. format: date type: string required: - currency - customFxRate type: object title: customRates PostInvoiceItemType: allOf: - properties: accountingCode: description: | The accounting code associated with the invoice item. type: string adjustmentLiabilityAccountingCode: description: | The accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string adjustmentRevenueAccountingCode: description: | The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string amount: description: | The amount of the invoice item. - For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. - For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax. type: number bookingReference: description: | The booking reference of the invoice item. type: string chargeDate: description: | The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string chargeName: description: | The name of the charge associated with the invoice item. This field is required if the `productRatePlanChargeId` field is not specified in the request. type: string contractAssetAccountingCode: description: | The accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractLiabilityAccountingCode: description: | The accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractRecognizedRevenueAccountingCode: description: | The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note:** This field is only available if you have Zuora Finance enabled. type: string description: description: | The description of the invoice item. type: string discountItems: description: | Container for discount items. The maximum number of discount items is 10. items: $ref: '#/components/schemas/PostDiscountItemType' type: array excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the invoice item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean itemType: description: | The type of the invoice item. type: string productRatePlanChargeId: description: | The ID of the product rate plan charge that the invoice item is created from. You must have the **Create Standalone Invoice With Product Catalog** permission to create an invoice item from an existing charge. If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body: - `chargeName` - `sku` - `uom` - `taxCode` - `taxMode` - `accountingCode` - `deferredRevenueAccountingCode` - `recognizedRevenueAccountingCode` type: string purchaseOrderNumber: description: | The purchase order number associated with the invoice item. type: string quantity: default: 1 description: | The number of units for the invoice item. type: number recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note:** This field is only available if you have Zuora Finance enabled. type: string revRecCode: description: | The revenue recognition code. type: string revRecTriggerCondition: description: | The date when revenue recognition is triggered. enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note:** This field is only available if you have Zuora Finance enabled. type: string serviceEndDate: description: | The service end date of the invoice item. format: date type: string serviceStartDate: description: | The service start date of the invoice item. format: date type: string sku: description: | The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to the invoice item. **Note**: This field is only available only if you have Taxation enabled. type: string taxItems: description: | Container for taxation items. The maximum number of taxation items is 5. **Note**: This field is only available only if you have Taxation enabled. items: $ref: '#/components/schemas/PostTaxationItemType' type: array taxMode: description: | The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. **Note**: This field is only available only if you have Taxation enabled. enum: - TaxInclusive - TaxExclusive type: string unbilledReceivablesAccountingCode: description: | The accounting code for unbilled receivables. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string unitPrice: description: | The per-unit price of the invoice item. To pass Level 3 data to the gateway, this field is required and must be greater than zero. type: number uom: description: | The unit of measure. type: string required: - amount - serviceStartDate title: invoiceItems type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' PostDiscountItemType: allOf: - properties: accountingCode: description: | The accounting code associated with the discount item. type: string accountsReceivableAccountingCode: description: | The accounting code for accounts receivable. type: string adjustmentLiabilityAccountingCode: description: | The accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string adjustmentRevenueAccountingCode: description: | The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string amount: description: | The amount of the discount item. - Should be a negative number. For example, `-10`. - Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model). - For tax-exclusive discount items, this amount indicates the discount item amount excluding tax. - For tax-inclusive discount items, this amount indicates the discount item amount including tax. type: number bookingReference: description: | The booking reference of the discount item. type: string chargeDate: description: | The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string chargeName: description: | The name of the charge associated with the discount item. This field is required if the `productRatePlanChargeId` field is not specified in the request body. type: string contractAssetAccountingCode: description: | The accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractLiabilityAccountingCode: description: | The accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractRecognizedRevenueAccountingCode: description: | The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note:** This field is only available if you have Zuora Finance enabled. type: string description: description: | The description of the discount item. type: string itemType: description: | The type of the discount item. type: string productRatePlanChargeId: description: | The ID of the product rate plan charge that the discount item is created from. If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding product rate plan charge, regardless of the values specified in the request body: - `chargeName` - `sku` If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding discount charge that [uses discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body: - `accountingCode` - `deferredRevenueAccountingCode` - `recognizedRevenueAccountingCode` If you specify a value for the `productRatePlanChargeId` field in the request, Zuora directly copies the values of the following fields from the corresponding invoice item charge if the discount charge DOES NOT [use discount specific accounting codes, rule and segment to manage revenue](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/Manage_Discount_Charges#Use_discount_specific_accounting_codes.2C_rule_and_segment_to_manage_revenue), regardless of the values specified in the request body: - `accountingCode` - `deferredRevenueAccountingCode` - `recognizedRevenueAccountingCode` type: string purchaseOrderNumber: description: | The purchase order number associated with the discount item. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note:** This field is only available if you have Zuora Finance enabled. type: string revRecCode: description: | The revenue recognition code. type: string revRecTriggerCondition: description: | The date when revenue recognition is triggered. enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note:** This field is only available if you have Zuora Finance enabled. type: string sku: description: | The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product. type: string taxItems: description: | Container for taxation items. The maximum number of taxation items is 5. **Note**: This field is only available only if you have Taxation enabled. items: $ref: '#/components/schemas/PostTaxationItemType' type: array unbilledReceivablesAccountingCode: description: | The accounting code for unbilled receivables. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string unitPrice: description: | The per-unit price of the discount item. If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF. type: number required: - amount title: invoiceItems type: object - $ref: '#/components/schemas/DiscountItemObjectNSFields' - $ref: '#/components/schemas/DiscountItemObjectCustomFields' PostTaxationItemType: allOf: - properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: number type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of taxation. type: string taxAmount: description: | The amount of the taxation item in the invoice item. format: number type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific invoice item. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the invoice item, in `yyyy-mm-dd` format. format: date type: string taxMode: description: | The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. enum: - TaxInclusive - TaxExclusive type: string taxRate: description: | The tax rate applied to the invoice item. format: number type: string taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the invoice item. enum: - Percentage - FlatFee type: string required: - name - taxAmount - taxDate - taxMode - taxRate - taxRateType title: taxItems type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' InvoiceItemObjectNSFields: description: | Container for Invoice Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: invoiceItemFieldsNS type: object InvoiceItemObjectCustomFields: additionalProperties: description: | Custom fields of the Invoice Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Invoice Item object. title: invoiceItemFieldsCustom type: object TaxationItemObjectCustomFields: additionalProperties: description: | Custom fields of the Taxation Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Taxation Item object. title: taxationItemFieldsCustom type: object DiscountItemObjectNSFields: description: | Container for discount Item fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the invoice item's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the invoice item was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: discountItemFieldsNS type: object DiscountItemObjectCustomFields: additionalProperties: description: | Custom fields of the Discount Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Discount Item object. title: discountItemFieldsCustom type: object ContactCustomFields: additionalProperties: description: | Custom fields of the Contact object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. type: object PutBatchInvoiceType: example: invoices: - id: 2c93808457d787030157e031d86c4c57 invoiceDate: '2017-12-16' - id: 2c92c8955bd63cc1015bd7c151af02ab invoiceDate: '2017-12-16' properties: invoices: description: | Container for invoice update details. items: $ref: '#/components/schemas/BatchInvoiceType' type: array type: object BatchInvoiceType: allOf: - properties: autoPay: description: | Whether invoices are automatically picked up for processing in the corresponding payment run. By default, invoices are automatically picked up for processing in the corresponding payment run. type: boolean comments: description: | Additional information related to the invoice that a Zuora user added to the invoice. maxLength: 255 type: string dueDate: description: | The date by which the payment for this invoice is due. format: date type: string id: description: | The ID of the invoice to be updated. type: string invoiceDate: description: | The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period. You can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs. format: date type: string invoiceItems: description: | Container for invoice items. The maximum number of items is 1,000. items: $ref: '#/components/schemas/PutInvoiceItemType' type: array transferredToAccounting: description: | Whether the invoice was transferred to an external accounting system. enum: - Processing - 'Yes' - Error - Ignore type: string templateId: description: | The ID of the invoice template associated with the invoice. **Note**: This field is only available if you have the Flexible Billing Attributes feature enabled. type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' title: invoices PutInvoiceItemType: allOf: - properties: accountingCode: description: | The accounting code associated with the invoice item. type: string adjustmentLiabilityAccountingCode: description: | The accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string adjustmentRevenueAccountingCode: description: | The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string amount: description: | The amount of the invoice item. - For tax-inclusive invoice items, the amount indicates the invoice item amount including tax. - For tax-exclusive invoice items, the amount indicates the invoice item amount excluding tax. type: number bookingReference: description: | The booking reference of the invoice item. **Note**: This field is only available if `id` is null. type: string chargeDate: description: | The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string chargeName: description: | The name of the charge associated with the invoice item. This field is required if the `productRatePlanChargeId` field is not specified in the request. type: string contractAssetAccountingCode: description: | The accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractLiabilityAccountingCode: description: | The accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractRecognizedRevenueAccountingCode: description: | The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note:** This field is only available if you have Zuora Finance enabled. type: string delete: description: | Indicates whether to delete the existing invoice item. **Note**: Set this field to `true` and specify an item `id` to delete an item. type: boolean description: description: | The description of the invoice item. type: string discountItems: description: | Container for discount items. The maximum number of discount items is 10. items: $ref: '#/components/schemas/PutDiscountItemType' type: array excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude the invoice item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean id: description: | The unique ID of the invoice item. - Specify this field when updating or deleting an existing memo item. - Do not specify this field when creating a memo item. type: string itemType: description: | The type of the invoice item. type: string productRatePlanChargeId: description: | The ID of the product rate plan charge that the invoice item is created from. If you specify the ID of a product rate plan charge in this field, no matter whether the following fields are specified with values, the following fields use the values from the corresponding product rate plan charge instead of the specified values: - `chargeName` - `sku` - `uom` - `taxCode` - `taxMode` - `accountingCode` - `deferredRevenueAccountingCode` - `recognizedRevenueAccountingCode` **Note**: Do not specify the invoice item `id` when specifying this field. type: string purchaseOrderNumber: description: | The purchase order number associated the invoice item. type: string quantity: description: | The number of units for the invoice item. format: number type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note:** This field is only available if you have Zuora Finance enabled. type: string revRecCode: description: | The revenue recognition code. type: string revRecTriggerCondition: description: | The date when revenue recognition is triggered. enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note:** This field is only available if you have Zuora Finance enabled. type: string serviceEndDate: description: | The service end date of the invoice item. format: date type: string serviceStartDate: description: | The service start date of the invoice item. format: date type: string sku: description: | The SKU of the invoice item. The SKU of the invoice item must be different from the SKU of any existing product. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to the invoice item. **Note:** - This field is only available if you have Taxation enabled. - If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed. type: string taxMode: description: | The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. **Note:** - This field is only available if you have Taxation enabled. - If the values of both `taxCode` and `taxMode` fields are changed to `null` when updating a standalone invoice, the corresponding `invoiceItems` > `taxItems` field and its nested fields specified in the creation request will be removed. enum: - TaxInclusive - TaxExclusive type: string unbilledReceivablesAccountingCode: description: | The accounting code for unbilled receivables. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string unitPrice: description: | The per-unit price of the invoice item. format: number type: string uom: description: | The unit of measure. type: string type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' PutDiscountItemType: allOf: - properties: accountingCode: description: | The accounting code associated with the discount item. type: string adjustmentLiabilityAccountingCode: description: | The accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string adjustmentRevenueAccountingCode: description: | The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string amount: description: | The amount of the discount item. - Should be a negative number. For example, `-10`. - Always a fixed amount no matter whether the discount charge associated with the discount item uses the [fixed-amount model or percentage model](https://knowledgecenter.zuora.com/Billing/Subscriptions/Product_Catalog/B_Charge_Models/B_Discount_Charge_Models#Fixed_amount_model_and_percentage_model). - For tax-exclusive discount items, this amount indicates the discount item amount excluding tax. - For tax-inclusive discount items, this amount indicates the discount item amount including tax. format: number type: string bookingReference: description: | The booking reference of the discount item. type: string chargeDate: description: | The date when the discount item is charged, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string chargeName: description: | The name of the charge associated with the discount item. This field is required if the `productRatePlanChargeId` field is not specified in the request. type: string contractAssetAccountingCode: description: | The accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractLiabilityAccountingCode: description: | The accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractRecognizedRevenueAccountingCode: description: | The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. **Note:** This field is only available if you have Zuora Finance enabled. type: string description: description: | The description of the discount item. type: string id: description: | The unique ID of the discount item. type: string itemType: description: | The type of the discount item. type: string purchaseOrderNumber: description: | The purchase order number associated with the discount item. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. **Note:** This field is only available if you have Zuora Finance enabled. type: string revRecCode: description: | The revenue recognition code. type: string revRecTriggerCondition: description: | The date when revenue recognition is triggered. enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. **Note:** This field is only available if you have Zuora Finance enabled. type: string sku: description: | The SKU of the invoice item. The SKU of the discount item must be different from the SKU of any existing product. type: string unbilledReceivablesAccountingCode: description: | The accounting code for unbilled receivables. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string unitPrice: description: | The per-unit price of the discount item. If the discount charge associated with the discount item uses the percentage model, the unit price will display as a percentage amount in PDF. For example: if unit price is 5.00, it will display as 5.00% in PDF. format: number type: string required: - amount title: invoiceItems type: object - $ref: '#/components/schemas/DiscountItemObjectNSFields' - $ref: '#/components/schemas/DiscountItemObjectCustomFields' PostBatchInvoicesType: example: invoices: - accountId: ff8080817cda56fa017cda87aaa2071e autoPay: false comments: comments currency: EUR invoiceDate: '2020-02-01' invoiceItems: - amount: 100 bookingReference: bookingReference chargeDate: '2020-02-01 00:00:00' description: description discountItems: - amount: -10 bookingReference: discountBookingReference chargeDate: '2020-02-01 11:00:00' chargeName: discount description: description sku: SKU-0002 taxItems: - exemptAmount: 0 jurisdiction: jurisdiction locationCode: locationCode name: country tax taxAmount: -1 taxCode: country tax code taxCodeDescription: country tax code, tax rate 10% taxDate: '2021-02-08' taxMode: TaxExclusive taxRate: 0.1 taxRateDescription: country tax taxRateType: Percentage productRatePlanChargeId: ff8080817cda56fa017cda87999d071b purchaseOrderNumber: PO-000303 quantity: 1 serviceEndDate: '2020-02-10' serviceStartDate: '2020-02-01' taxItems: - exemptAmount: 0 jurisdiction: juristiction locationCode: locationCode name: country tax taxAmount: 10 taxCode: tax code taxCodeDescription: tax code description taxDate: '2020-02-01' taxMode: TaxExclusive taxRate: 0.01 taxRateDescription: tax rate description taxRateType: Percentage - amount: 100 bookingReference: bookingReference chargeDate: '2020-02-01 00:00:00' chargeName: charge name description: description purchaseOrderNumber: PO-000303 quantity: 1 serviceEndDate: '2020-02-10' serviceStartDate: '2020-02-01' sku: sku-001 uom: each - accountId: ff8080817cda56fa017cda87aaa2071e autoPay: false comments: comments currency: EUR invoiceDate: '2020-02-01' invoiceItems: - amount: 100 bookingReference: bookingReference chargeDate: '2020-02-01 00:00:00' description: description productRatePlanChargeId: ff8080817cda56fa017cda87999d071b purchaseOrderNumber: PO-000303 quantity: 1 serviceEndDate: '2020-02-10' serviceStartDate: '2020-02-01' taxItems: - exemptAmount: 0 jurisdiction: juristiction locationCode: locationCode name: country tax taxAmount: 10 taxCode: tax code taxCodeDescription: tax code description taxDate: '2020-02-01' taxMode: TaxExclusive taxRate: 0.01 taxRateDescription: tax rate description taxRateType: Percentage - amount: 100 bookingReference: bookingReference chargeDate: '2020-02-01 00:00:00' chargeName: charge name description: description purchaseOrderNumber: PO-000303 quantity: 1 serviceEndDate: '2020-02-10' serviceStartDate: '2020-02-01' sku: sku-001 uom: each useSingleTransaction: false properties: invoices: description: | Container for standalone invoices. items: $ref: '#/components/schemas/PostInvoiceType' type: array useSingleTransaction: description: | Whether a batch request is handled with a single transaction. - `true` indicates that a batch request will be handled with a single transaction. - `false` indicates that the standalone invoices to be created in a batch request will be handled with separated transactions. If the field is set to `false`, a failure in the batch request will not cause the whole request to fail, so you have to retry the whole batch request. type: boolean type: object PostBatchInvoiceResponse: properties: invoices: items: $ref: '#/components/schemas/PostBatchInvoiceItemResponse' type: array success: description: | Indicates whether the call succeeded. type: boolean type: object PostBatchInvoiceItemResponse: allOf: - properties: success: description: | Indicates whether the invoice is created successfully. type: boolean type: object - $ref: '#/components/schemas/PostInvoiceResponse' POSTInvoicesBatchPostType: allOf: - properties: invoices: description: | The container for invoices to be posted. The maximum number of invoices to be posted is 50 in one request. items: $ref: '#/components/schemas/InvoicePostType' title: invoices type: array type: object example: invoices: - complexity__c: Middle description__c: description id: 402890555a7e9791015a7f15fe440123 invoiceDate: '2022-10-12' - complexity__c: Middle description__c: description id: 402890555a7e9791015a7f15fe44013a invoiceDate: '2022-10-12' - complexity__c: Middle description__c: description id: 402890555a7e9791015a7f15fe44012b invoiceDate: '2022-10-12' InvoicesBatchPostResponseType: allOf: - properties: invoices: description: | The container for a list of posted invoices. items: $ref: '#/components/schemas/InvoicePostResponseType' title: invoices type: array success: description: | Returns `true` if the request has one of invoices was posted successfully. type: boolean type: object InvoicePostResponseType: allOf: - properties: id: description: | The ID of the invoice that was posted. type: string success: description: | Returns `true` if the invoice was posted successfully. type: boolean type: object InvoicePostType: allOf: - properties: id: description: | The ID of the invoice to be posted. type: string invoiceDate: description: | The date that appears on the invoice being created, in `yyyy-mm-dd` format. The value cannot fall in a closed accounting period. format: date type: string type: object - $ref: '#/components/schemas/InvoiceObjectCustomFields' GetInvoicePdfStatusBatchResponse: description: '' example: invoiceFiles: - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - invoiceId: 2c98908a904dfc2601904e6e14090241 invoiceNumber: INV00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - invoiceId: 402824aa8cc894d5018cc8a120576881 invoiceNumber: INV00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true properties: invoiceFiles: description: | Array of invoice PDF statuses requested. items: $ref: '#/components/schemas/GetInvoicePdfStatusResponse' type: array success: description: | Indicates whether the call succeeded. type: boolean type: object title: invoiceFiles GetInvoicePdfStatusResponse: allOf: - properties: invoiceId: description: | The ID of the invoice whose pdf status is requested. type: string invoiceNumber: description: | The invoice number of the invoice whose pdf status is requested. type: string pdfGenerationStatus: description: | The generation status of the invoice PDF. - **Obsolete**: The status changes to `Obsolete` when additional updates are applied to the document, for example, payment applied or custom fields updated. - **Archived**: The status changes to `Archived` from `Generated` when the PDF file is archived. The file cannot be used directly until it is restored. For restoring, refer to the Restore a file operation. enum: - None - Pending - Processing - Generated - Error - Obsolete - Archived type: string createdOn: description: | The time at which the request to generate the PDF was created. type: string updatedOn: description: | The time at which the request to generate the PDF was updated. type: string pdfFileURL: description: | The file path or the URL of the PDF when the status is `Generated`. type: string errorCategory: description: | The error category when the status is `Error`. type: string errorMessage: description: | The error message when the status is `Error`. type: string type: object DeleteInvoiceResponseType: properties: id: description: | The ID of the deleted invoice. type: string jobId: description: | The ID of the job that handles the invoice deletion operation. You can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](https://developer.zuora.com/api-references/api/operation/GET_OperationJob/) API operation to query job information. type: string jobStatus: description: | The status of the invoice deletion operation. enum: - Pending - Completed type: string reasons: items: properties: code: description: | The error code of the response. type: string message: description: | The detail information of the error response. type: string type: object type: array success: description: | Whether the call succeeded. type: boolean type: object PutInvoiceType: allOf: - properties: autoPay: description: | Whether invoices are automatically picked up for processing in the corresponding payment run. By default, invoices are automatically picked up for processing in the corresponding payment run. type: boolean comments: description: | Additional information related to the invoice that a Zuora user added to the invoice. maxLength: 255 type: string dueDate: description: | The date by which the payment for this invoice is due. format: date type: string invoiceDate: description: | The new invoice date of the invoice. The new invoice date cannot fall in a closed accounting period. You can only specify `invoiceDate` or `dueDate` in one request. Otherwise, an error occurs. format: date type: string invoiceItems: description: | Container for invoice items, The maximum number of items is 1,000. items: $ref: '#/components/schemas/PutInvoiceItemType' type: array transferredToAccounting: description: | Whether the invoice was transferred to an external accounting system. enum: - Processing - 'Yes' - Error - Ignore type: string templateId: description: | The ID of the invoice template associated with the invoice. **Note**: This field is only available if you have the Flexible Billing Attributes feature enabled. type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' example: invoiceItems: - id: 8ad084db909fae930190a121c87f5800 amount: 105 PutInvoiceResponseType: allOf: - properties: accountId: description: | The ID of the customer account associated with the invoice. type: string amount: description: | The total amount of the invoice. format: BigDecimal type: number autoPay: description: | Whether invoices are automatically picked up for processing in the corresponding payment run. type: boolean balance: description: | The balance of the invoice. format: BigDecimal type: number cancelledById: description: | The ID of the Zuora user who cancelled the invoice. type: string nullable: true cancelledOn: description: | The date and time when the invoice was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the invoice. type: string createdById: description: | The ID of the Zuora user who created the invoice. type: string createdDate: description: | The date and time when the invoice was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditBalanceAdjustmentAmount: description: | **Note:** This filed is only available if you have the Credit Balance feature enabled and the Invoice Settlement feature disabled. The currency amount of the adjustment applied to the customer's credit balance. format: BigDecimal type: number currency: description: | A currency defined in the web-based UI administrative settings. type: string discount: description: | The discount of the invoice. format: BigDecimal type: number dueDate: description: | The date by which the payment for this invoice is due. format: date type: string id: description: | The unique ID of the invoice. type: string invoiceDate: description: | The date on which to generate the invoice. format: date type: string number: description: | The unique identification number of the invoice. type: string postedById: description: | The ID of the Zuora user who posted the invoice. type: string postedOn: description: | The date and time when the invoice was posted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string status: description: | The status of the invoice. enum: - Draft - Posted - Canceled - Error type: string success: description: | Returns `true` if the request was processed successfully. type: boolean targetDate: description: | The target date for the invoice, in `yyyy-mm-dd` format. For example, 2017-07-20. format: date type: string taxAmount: description: | The amount of taxation. format: BigDecimal type: number templateId: description: | The ID of the invoice template associated with the invoice. type: string totalTaxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: BigDecimal type: number transferredToAccounting: description: | Whether the invoice was transferred to an external accounting system. enum: - Processing - 'Yes' - Error - Ignore type: string updatedById: description: | The ID of the Zuora user who last updated the invoice. type: string updatedDate: description: | The date and time when the invoice was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/InvoiceObjectNSFields' - $ref: '#/components/schemas/InvoiceObjectCustomFields' GetInvoiceApplicationPartCollectionType: properties: applicationParts: description: | Container for application parts. items: $ref: '#/components/schemas/GetInvoiceApplicationPartType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GetInvoiceApplicationPartType: properties: appliedAmount: description: | The amount that is applied to the invoice. format: double type: number createdById: description: | The ID of the Zuora user who created the payment or credit memo. format: uuid type: string createdDate: description: | The date and time when the payment or credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10. format: date-time type: string creditMemoId: description: | The ID of credit memo that is applied to the specified invoice. format: uuid type: string paymentId: description: | The ID of the payment that is applied to the specified invoice. format: uuid type: string updatedById: description: | The ID of the Zuora user who last updated the payment or credit memo. format: uuid type: string updatedDate: description: | The date and time when the payment or credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16. format: date-time type: string title: applicationParts type: object PostInvoiceEmailRequestType: example: useEmailTemplateSetting: true properties: emailAddresses: description: | The valid email addresses you want to email an invoice to. Use commas to separate email addresses. **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`. type: string includeAdditionalEmailAddresses: default: false description: | Whether to send an invoice to the additional email addresses of the invoice account. You can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information. enum: - true - false type: boolean useEmailTemplateSetting: default: false description: | Indicates whether to email an invoice based on the email template setting. If you set this field to `true`, the invoice is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template. enum: - true - false type: boolean type: object GETInvoiceFilesResponse: properties: invoiceFiles: description: | Container for invoice PDF files. items: $ref: '#/components/schemas/InvoiceFile' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object InvoiceFile: properties: id: description: | The ID of the invoice PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID. type: string pdfFileUrl: description: | The relative URL of the invoice PDF file. You can obtain the absolute URL for downloading the file by adding a prefix in the following format: `{environment_base_url}/apps` For example, `https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d`. type: string versionNumber: description: | The version number of the invoice PDF file. format: int64 type: integer title: invoiceFiles type: object POSTUploadFileResponse: properties: fileId: description: | The unique ID of the uploaded PDF file. type: string success: description: | Indicates whether the call succeeded. type: boolean type: object GETInvoiceItemsResponse: properties: invoiceItems: description: | Container for invoice items. items: $ref: '#/components/schemas/InvoiceItem' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object InvoiceItem: allOf: - properties: accountingCode: description: The accounting code associated with the invoice item. type: string adjustmentLiabilityAccountingCode: description: | The accounting code for adjustment liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string adjustmentRevenueAccountingCode: description: | The accounting code for adjustment revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string appliedToItemId: description: The unique ID of the invoice item that the discount charge is applied to. type: string availableToCreditAmount: description: | The amount of the invoice item that is available to credit. format: decimal type: number balance: description: | The balance of the invoice item. **Note**: This field is only available if you have the Invoice Settlement feature enabled. format: decimal type: string bookingReference: description: | The booking reference of the invoice item. type: string chargeAmount: description: | The amount of the charge. **Note**: This amount does not include taxes regardless if the charge's tax mode is inclusive or exclusive. This is the discount amount actually applied when the invoice item is a discount charge. format: decimal type: string chargeDate: description: | The date when the invoice item is charged, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string chargeDescription: description: The description of the charge. type: string chargeId: description: The unique ID of the charge. type: string chargeName: description: The name of the charge. type: string chargeType: description: | The type of the charge. enum: - OneTime - Recurring - Usage type: string contractAssetAccountingCode: description: | The accounting code for contract asset. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractLiabilityAccountingCode: description: | The accounting code for contract liability. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string contractRecognizedRevenueAccountingCode: description: | The accounting code for contract recognized revenue. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string deferredRevenueAccountingCode: description: | The deferred revenue accounting code associated with the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. type: string description: description: The description of the invoice item. type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the invoice item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean fulfillmentId: description: | The reference ID of the fulfillment associated with the invoice item. type: string id: description: Item ID. type: string invoiceScheduleId: description: | The ID of the invoice schedule item by which Invoice Schedule Item the invoice item is generated by when the Invoice Schedule Item is executed. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string invoiceScheduleItemId: description: | The ID of the invoice schedule item associated with the invoice item. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string itemType: description: | The type of the invoice item. type: string numberOfDeliveries: description: | The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. type: number orderLineItemId: description: | The reference ID of the oder line item associated with the invoice item. type: string processingType: description: | The kind of the charge for the invoice item. enum: - Charge - Discount - Prepayment - Tax - Rounding type: string productName: description: Name of the product associated with this item. type: string productRatePlanChargeId: description: | The ID of the product rate plan charge that the invoice item is created from. type: string purchaseOrderNumber: description: | The purchase order number associated with the invoice item. type: string quantity: description: The quantity of this item, in the configured unit of measure for the charge. format: decimal type: string reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set both the `excludeItemBookingFromRevenueAccounting` and `ExcludeItemBillingFromRevenueAccounting` fields to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. recognizedRevenueAccountingCode: description: | The recognized revenue accounting code associated with the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. type: string revRecCode: description: | The revenue recognition code. type: string revRecTriggerCondition: description: | The date when revenue recognition is triggered. enum: - ContractEffectiveDate - ServiceActivationDate - CustomerAcceptanceDate type: string revenueRecognitionRuleName: description: | The revenue recognition rule of the invoice item. **Note:** This field is only available if you have Zuora Finance enabled. type: string serviceEndDate: description: The end date of the service period for this item, i.e., the last day of the service period, as _yyyy-mm-dd_. format: date type: string serviceStartDate: description: The start date of the service period for this item, as _yyyy-mm-dd_. For a one-time fee item, the date of the charge. format: date type: string sku: description: | The SKU of the invoice item. type: string shipToContactId: description: | The ID of the ship-to contact associated with the invoice item. type: string soldToContactId: description: | The ID of the sold-to contact associated with the invoice item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the invoice item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string sourceItemType: description: | The type of the source item. enum: - SubscriptionComponent - Rounding - ProductRatePlanCharge - None - OrderLineItem type: string subscriptionId: description: The ID of the subscription for this item. type: string subscriptionName: description: The name of the subscription for this item. type: string taxAmount: description: Tax applied to the charge. format: decimal type: string taxCode: description: | The tax code of the invoice item. **Note** Only when taxation feature is enabled, this field can be presented. type: string taxMode: description: | The tax mode of the invoice item. **Note** Only when taxation feature is enabled, this field can be presented. type: string taxationItems: description: | Container for the taxation items of the invoice item. properties: data: description: | List of taxation items. items: $ref: '#/components/schemas/GETInvoiceTaxItemType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string type: object unbilledReceivablesAccountingCode: description: | The accounting code for unbilled receivables. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: string unitOfMeasure: description: Unit used to measure consumption. type: string unitPrice: description: | The per-unit price of the invoice item. **Note**: For discount charges, this represents the discount percentage (for percentage-based discounts) or the discount amount (for fixed-amount discounts). format: double type: number type: object - $ref: '#/components/schemas/InvoiceItemObjectNSFields' - $ref: '#/components/schemas/InvoiceItemObjectCustomFields' title: invoiceItems GETInvoiceTaxItemType: allOf: - $ref: '#/components/schemas/TaxationItemObjectCustomFields' - properties: availableToCreditAmount: description: | The amount of the invoice taxation item that is available to credit. format: decimal type: number applicableTaxUnRounded: description: | The unrounded amount of the tax. type: number country: description: | The field which contains country code. type: string balance: description: | The balance of the taxation item. format: double type: number creditAmount: description: | The amount of credit memos applied to the taxation item. format: double type: number exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number id: description: | The ID of the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of the taxation item. type: string paymentAmount: description: | The amount of payments applied to the taxation item. format: double type: number taxAmount: description: | The amount of taxation. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific invoice. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the invoice, in `yyyy-mm-dd` format. format: date type: string taxRate: description: | The tax rate applied to the invoice. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate. enum: - Percentage - FlatFee type: string title: data type: object title: data GETInvoiceTaxationItemsResponse: properties: data: description: | Container for the taxation items of the invoice item. items: $ref: '#/components/schemas/GETInvoiceTaxItemType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object PutReverseInvoiceType: example: applyEffectiveDate: '2017-02-20' memoDate: '2017-02-20' properties: applyEffectiveDate: description: | The date when the credit memo is applied to the invoice that will be reversed, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date. The default value is the date when you reverse the invoice and create the credit memo. format: date type: string comment: description: | Comments about the reversal. The comment is used as the comment of the credit memo generated by reversing the specified invoice. maxLength: 255 minLength: 0 type: string memoDate: description: | The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date. The default value is the date when you reverse the invoice and create the credit memo. format: date type: string reasonCode: description: | A code identifying the reason for the reversal. The value must be an existing reason code or empty. The code is used as the reason code of the credit memo generated by reversing the specified invoice. If you do not specify a value, Zuora uses the default reason code `Invoice reversal` for the credit memo. type: string type: object PutReverseInvoiceResponseType: properties: creditMemo: description: | Container for the credit memo that is automatically generated when during the invoice reversal. properties: id: description: The ID of the credit memo. type: string type: object debitMemo: description: | Container for the debit memo that is automatically generated during the reversal of the credit memo related to this invoice. If no related credit memo is reversed, this field is not retruned in the response body. properties: id: description: The ID of the debit memo. type: string type: object id: type: string nullable: true description: | The ID of the invoice to be reserved. This field is available only when the reversal operation is performed asynchronously. jobId: type: string nullable: true description: | The ID of the job that handles the invoice reversal operation. You can specify the value of this field as the value of the `jobId` path parameter in the [Retrieve an operation job](https://developer.zuora.com/v1-api-reference/api/operation/GET_OperationJob/) API operation to query job information. This field is available only when the reversal operation is performed asynchronously. jobStatus: type: string nullable: true enum: - Pending - Processing - Failed - Completed description: | The status of the invoice reversal operation. This field is available only when the reversal operation is performed asynchronously. success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTTaxationItemList: example: taxationItems: - exemptAmount: 0 financeInformation: accountsReceivableAccountingCode: Check salesTaxPayableAccountingCode: Check invoiceItemId: 402890555a7e9791015a879f064d0055 jurisdiction: CALIFORNIA locationCode: '06' name: STATE TAX taxAmount: 0.1 taxCode: ServiceTaxCode taxCodeDescription: This is tax code description! taxDate: '2016-09-30' taxMode: TaxExclusive taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage properties: taxationItems: description: | Container for taxation items. items: $ref: '#/components/schemas/POSTTaxationItemTypeForInvoice' type: array type: object GETTaxationItemListType: properties: success: description: Returns `true` if the request was processed successfully. type: boolean taxationItems: description: | Container for taxation items. items: $ref: '#/components/schemas/GETTaxationItemTypewithSuccess' type: array type: object GETTaxationItemTypewithSuccess: allOf: - properties: createdById: description: | The ID of the Zuora user who created the taxation item. type: string createdDate: description: | The date and time when the taxation item was created in the Zuora system, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: accountsReceivableAccountingCode: description: | The accounting code for accounts receivable. type: string accountsReceivableAccountingCodeType: description: | The type of the accounting code for accounts receivable. type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. type: string salesTaxPayableAccountingCodeType: description: | The type of the accounting code for the sales taxes payable. type: string type: object id: description: | The ID of the taxation item. type: string invoiceItemId: description: | The ID of the invoice associated with the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string nullable: true name: description: | The name of the taxation item. type: string taxAmount: description: | The amount of the tax applied to the invoice. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific invoice. type: string taxCodeDescription: description: | The description of the tax code. type: string nullable: true taxDate: description: | The date when the tax is applied to the invoice. format: date type: string taxMode: description: | The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. enum: - TaxInclusive - TaxExclusive type: string taxRate: description: | The tax rate applied to the invoice. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string nullable: true taxRateType: description: | The type of the tax rate applied to the invoice. enum: - Percentage - FlatFee type: string updatedById: description: | The ID of the Zuora user who last updated the taxation item. type: string updatedDate: description: | The date and time when the taxation item was last updated, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems POSTTaxationItemTypeForInvoice: allOf: - properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: number type: string financeInformation: description: | Container for the finance information related to the taxation item. properties: accountsReceivableAccountingCode: description: | The accounting code for accounts receivable. maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object invoiceItemId: description: | The ID of the invoice associated with the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of taxation. type: string taxAmount: description: | The amount of the taxation item in the invoice item. format: number type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific invoice item. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the invoice item, in `yyyy-mm-dd` format. format: date type: string taxMode: description: | The tax mode of the invoice item, indicating whether the amount of the invoice item includes tax. enum: - TaxInclusive - TaxExclusive type: string taxRate: description: | The tax rate applied to the invoice item. format: number type: string taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the invoice item. enum: - Percentage - FlatFee type: string required: - invoiceItemId - jurisdiction - name - taxAmount - taxDate - taxRate - taxRateType title: taxItems type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' PUTWriteOffInvoiceRequest: allOf: - properties: comment: description: | Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice. maxLength: 255 minLength: 0 type: string items: description: | Container for items. This field is optional. **Note:** If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice. items: $ref: '#/components/schemas/CreditMemoItemFromWriteOffInvoice' type: array memoDate: description: | The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date. The default value is the date when you write off the invoice. format: date type: string revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice The **Exclude Billing Item From Revenue** field will be automatically set to **Yes** by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing. If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. **Note**: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. enum: - 'Yes' - 'No' default: 'Yes' type: string amount: description: | The write off amount of the invoice. **Note**: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. type: number taxAutoCalculation: description: | Indicates whether to automatically calculate taxes in the credit memo. type: boolean nonRevenueWriteOffAccountingCode: description: | Specify the accounting code for the non revenue write off. Available only if `revenueImpacting` = `no`. **Note**: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code `Write-off`. type: string type: object - $ref: '#/components/schemas/CreditMemoObjectCustomFields' - $ref: '#/components/schemas/CreditMemoObjectNSFields' example: memoDate: '2019-01-02' type: object PUTWriteOffInvoiceResponse: properties: creditMemo: description: | Container for the credit memo that is automatically generated when writing off invoices. properties: id: description: | The ID of the credit memo that is created when the invoice is written off. type: string type: object success: description: | Returns `true` if the request was processed successfully. type: boolean type: object CreditMemoItemFromWriteOffInvoice: allOf: - properties: comment: description: | Comments about the credit memo item. type: string financeInformation: description: | Container for the finance information related to the credit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object invoiceItemId: description: | The ID of the invoice item. type: string serviceEndDate: description: | The service end date of the credit memo item. format: date type: string amountWithoutTax: description: | The write off amount of the invoice item excluding tax. type: number serviceStartDate: description: | The service start date of the credit memo item. format: date type: string skuName: description: | The name of the charge associated with the invoice. type: string unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string taxationItems: description: | Container for the taxation items of the credit memo item. **Note**: * This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. * This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). items: properties: amount: description: | The credit memo taxation amount. type: number taxationItemId: description: | The Id of the debit memo item. type: string type: object type: array type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items CreditMemoObjectCustomFields: additionalProperties: description: | Custom fields of the Credit Memo object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Credit Memo object. title: creditMemoFieldsCustom type: object CreditMemoObjectNSFields: description: | Container for Credit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the credit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Origin__NS: description: | Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the credit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Transaction__NS: description: | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: creditMemoFieldsNS type: object CreditMemoItemObjectCustomFields: additionalProperties: description: | Custom fields of the Credit Memo Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Credit Memo Item object. title: creditMemoItemFieldsCustom type: object GETCreditMemoCollectionType: properties: creditmemos: description: | Container for credit memos. items: $ref: '#/components/schemas/GETCreditMemoTypewithSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETCreditMemoTypewithSuccess: allOf: - properties: accountId: description: | The ID of the customer account associated with the credit memo. type: string accountNumber: description: | The number of the account associated with the credit memo. type: string amount: description: | The total amount of the credit memo. format: double type: number appliedAmount: description: | The applied amount of the credit memo. format: double type: number autoApplyUponPosting: description: | Whether the credit memo automatically applies to the invoice upon posting. type: boolean billToContactId: description: | The ID of the bill-to contact associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true cancelledById: description: | The ID of the Zuora user who cancelled the credit memo. type: string nullable: true cancelledOn: description: | The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the credit memo. type: string nullable: true createdById: description: | The ID of the Zuora user who created the credit memo. type: string createdDate: description: | The date and time when the credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditMemoDate: description: | The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20. format: date type: string currency: description: | The currency of the credit memo. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. type: string nullable: true einvoiceErrorCode: description: | The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceErrorMessage: description: | The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceFileId: description: | The ID of the e-invoice file generated for the credit memo. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceStatus: description: | The status of the e-invoice file generation for the credit memo. - If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeFromAutoApplyRules: description: | Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. type: boolean id: description: | The unique ID of the credit memo. type: string invoiceGroupNumber: description: | The number of the invoice group associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true latestPDFFileId: description: | The ID of the latest PDF file generated for the credit memo. type: string number: description: | The unique identification number of the credit memo. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string postedById: description: | The ID of the Zuora user who posted the credit memo. type: string nullable: true postedOn: description: | The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. type: string referredInvoiceId: description: | The ID of a referred invoice. type: string nullable: true refundAmount: description: | The amount of the refund on the credit memo. format: double type: number revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. enum: - 'Yes' - 'No' default: 'Yes' type: string reversed: description: | Whether the credit memo is reversed. type: boolean sequenceSetId: description: | The ID of the sequence set associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the credit memo. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true source: description: | The source of the credit memo. Possible values: - `BillRun`: The credit memo is generated by a bill run. - `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations. - `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation. - `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation. - `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation. - `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation. type: string sourceId: description: | The ID of the credit memo source. If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`. type: string sourceType: description: | The type of the credit memo source. enum: - Subscription - Standalone - Invoice - Order - CreditMemo - Consolidation type: string status: description: | The status of the credit memo. enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string targetDate: description: | The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20. format: date type: string nullable: true taxAmount: description: | The amount of taxation. format: double type: number taxMessage: description: | The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure. type: string nullable: true taxStatus: description: | The status of tax calculation related to the credit memo. **Note**: This field is only applicable to tax calculation by third-party tax engines. Also, the `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number transferredToAccounting: description: | Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedAmount: description: | The unapplied amount of the credit memo. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the credit memo. type: string updatedDate: description: | The date and time when the credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' title: creditmemos CreditMemoFromChargeRequest: allOf: - properties: accountId: description: | The ID of the account associated with the credit memo. **Note**: When creating credit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string accountNumber: description: | The number of the customer account associated with the credit memo. **Note**: When creating credit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string autoPost: default: false description: | Whether to automatically post the credit memo after it is created. Setting this field to `true`, you do not need to separately call the [Post a credit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo. type: boolean charges: description: | Container for product rate plan charges. The maximum number of items is 1,000. items: $ref: '#/components/schemas/CreditMemoFromChargeDetailType' maxItems: 1000 type: array comment: description: | Comments about the credit memo. type: string currency: description: | The code of a currency as defined in Billing Settings through the Zuora UI. If you do not specify a currency during credit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both). **Note**: - The API custom rate feature is permission controlled. - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. - CreditMemo, CreditMemoItem, and CreditMemoItemTax will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency. items: $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType' maxItems: 2 type: array effectiveDate: description: | The date when the credit memo takes effect. format: date type: string excludeFromAutoApplyRules: default: false description: | Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos. type: boolean number: type: string maxLength: 32 description: | A customized credit memo number with the following format requirements: - Max length: 32 characters - Acceptable characters: a-z,A-Z,0-9,-,_ The value must be unique in the system, otherwise it may cause issues with bill runs and subscriptions. If not provided, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see Configure prefix and numbering for billing documents. reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' example: accountId: 8ad09be48db5aba7018db604776d4854 charges: - amount: 10 productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 title: memos GETCreditMemoType: allOf: - properties: accountId: description: | The ID of the customer account associated with the credit memo. type: string accountNumber: description: | The number of the customer account associated with the credit memo. type: string amount: description: | The total amount of the credit memo. format: double type: number appliedAmount: description: | The applied amount of the credit memo. format: double type: number autoApplyUponPosting: description: | Whether the credit memo automatically applies to the invoice upon posting. type: boolean billToContactId: description: | The ID of the bill-to contact associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true billToContactSnapshotId: description: | The ID of the bill-to contact snapshot associated with the credit memo. The value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled. type: string nullable: true cancelledById: description: | The ID of the Zuora user who cancelled the credit memo. type: string nullable: true cancelledOn: description: | The date and time when the credit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the credit memo. type: string nullable: true createdById: description: | The ID of the Zuora user who created the credit memo. type: string createdDate: description: | The date and time when the credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditMemoDate: description: | The date when the credit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20. format: date type: string currency: description: | The currency of the credit memo. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. type: string nullable: true einvoiceErrorCode: description: | The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceErrorMessage: description: | The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceFileId: description: | The ID of the e-invoice file generated for the credit memo. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceStatus: description: | The status of the e-invoice file generation for the credit memo. - If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeFromAutoApplyRules: description: | Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices. type: boolean excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean id: description: | The unique ID of the credit memo. type: string invoiceGroupNumber: description: | The number of the invoice group associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true latestPDFFileId: description: | The ID of the latest PDF file generated for the credit memo. type: string nullable: true number: description: | The unique identification number of the credit memo. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string postedById: description: | The ID of the Zuora user who posted the credit memo. type: string postedOn: description: | The date and time when the credit memo was posted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. type: string referredInvoiceId: description: | The ID of a referred invoice. type: string nullable: true refundAmount: description: | The amount of the refund on the credit memo. format: double type: number revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. enum: - 'Yes' - 'No' default: 'Yes' type: string reversed: description: | Whether the credit memo is reversed. type: boolean sequenceSetId: description: | The ID of the sequence set associated with the credit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the credit memo. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true source: description: | The source of the credit memo. Possible values: - `BillRun`: The credit memo is generated by a bill run. - `API`: The credit memo is created by calling the [Invoice and collect](https://developer.zuora.com/api-references/api/operation/POST_TransactionInvoicePayment) operation, or by calling the Orders, Order Line Items, or Fulfillments API operations. - `ApiSubscribe`: The credit memo is created by calling the [Create subscription](https://developer.zuora.com/api-references/api/operation/POST_Subscription) and [Create account](https://developer.zuora.com/api-references/api/operation/POST_Account) operation. - `ApiAmend`: The credit memo is created by calling the [Update subscription](https://developer.zuora.com/api-references/api/operation/PUT_Subscription) operation. - `AdhocFromPrpc`: The credit memo is created from a product rate plan charge through the Zuora UI or by calling the [Create a credit memo from a charge](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromPrpc) operation. - `AdhocFromInvoice`: The credit memo is created from an invoice or created by reversing an invoice. You can create a credit memo from an invoice through the Zuora UI or by calling the [Create credit memo from invoice](https://developer.zuora.com/api-references/api/operation/POST_CreditMemoFromInvoice) operation. You can create a credit memo by reversing an invoice through the Zuora UI or by calling the [Reverse invoice](https://developer.zuora.com/api-references/api/operation/PUT_ReverseInvoice) operation. type: string sourceId: description: | The ID of the credit memo source. If a credit memo is generated from a bill run, the value is the number of the corresponding bill run. Otherwise, the value is `null`. type: string nullable: true sourceType: description: | The type of the credit memo source. enum: - Subscription - Standalone - Invoice - Order - CreditMemo - Consolidation type: string status: description: | The status of the credit memo. enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string success: description: Returns `true` if the request was processed successfully. type: boolean targetDate: description: | The target date for the credit memo, in `yyyy-mm-dd` format. For example, 2017-07-20. format: date type: string nullable: true taxAmount: description: | The amount of taxation. format: double type: number taxMessage: description: | The message about the status of tax calculation related to the credit memo. If tax calculation fails in one credit memo, this field displays the reason for the failure. type: string nullable: true taxStatus: description: | The status of tax calculation related to the credit memo. **Note**: This field is only applicable to tax calculation by third-party tax engines. Also, the `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number transferredToAccounting: description: | Whether the credit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedAmount: description: | The unapplied amount of the credit memo. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the credit memo. type: string updatedDate: description: | The date and time when the credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' CreditMemoFromChargeDetailType: allOf: - properties: amount: description: | The amount of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: double type: number excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean description: description: | The description of the product rate plan charge. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). maxLength: 255 minLength: 0 type: string financeInformation: description: | Container for the finance information related to the product rate plan charge associated with the credit memo. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object productRatePlanChargeId: description: | The ID of the product rate plan charge that the credit memo is created from. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string quantity: description: | The number of units for the credit memo item. format: double type: number serviceEndDate: description: | The service end date of the credit memo item. If not specified, the effective end date of the corresponding product rate plan will be used. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. If not specified, the effective start date of the corresponding product rate plan will be used. format: date type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: charges CreditMemoFromChargeCustomRatesType: allOf: - properties: currency: description: | The currency code for either Reporting or Home currency. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string customFxRate: description: | The Custom FX conversion rate between Home/Reporting and Transactional currency items. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: decimal type: number rateDate: description: | The date on which a particular currency rate is fixed or obtained on. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string required: - currency - customFxRate type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: customRates POSTBulkCreditMemosRequestType: discriminator: propertyName: sourceType mapping: Invoice: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest' Standalone: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest' oneOf: - $ref: '#/components/schemas/BulkCreateCreditMemosFromInvoiceRequest' - $ref: '#/components/schemas/BulkCreateCreditMemosFromChargeRequest' BulkCreditMemosResponseType: allOf: - properties: memos: description: | The container for a list of credit memos. items: $ref: '#/components/schemas/GETCreditMemoType' maxItems: 50 title: memos type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object BulkCreateCreditMemosFromInvoiceRequest: properties: sourceType: type: string enum: - Invoice description: | The type of the source where credit memos are created. This enum field has the following values: - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices. - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges. The specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field. - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list. - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list. memos: description: | The container for a list of credit memos. The maximum number of credit memos is 50. items: $ref: '#/components/schemas/CreditMemoFromInvoiceRequest' maxItems: 50 type: array required: - sourceType type: object BulkCreateCreditMemosFromChargeRequest: properties: sourceType: type: string enum: - Standalone - Invoice description: | The type of the source where credit memos are created. This enum field has the following values: - `Invoice`: By setting this field to `Invoice`, you can create multiple credit memos from invoices. - `Standalone`: By setting this field to `Standalone`, you can create multiple credit memos from product rate plan charges. The specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field. - To view the `memos` schema applicable to credit memo creation from invoices, select `Invoice` from the following drop-down list. - To view the `memos` schema applicable to credit memo creation from product rate plan charges, select `Standalone` from the following drop-down list. memos: description: | The container for a list of credit memos. The maximum number of credit memos is 50. items: $ref: '#/components/schemas/CreditMemoFromChargeRequest' maxItems: 50 type: array required: - sourceType type: object CreditMemoFromInvoiceRequest: allOf: - properties: autoApplyToInvoiceUponPosting: description: | Whether the credit memo automatically applies to the invoice upon posting. type: boolean autoPost: default: false description: | Whether to automatically post the credit memo after it is created. Setting this field to `true`, you do not need to separately call the [Post credit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostCreditMemo) operation to post the credit memo. type: boolean comment: description: | Comments about the credit memo. maxLength: 255 minLength: 0 type: string effectiveDate: description: | The date when the credit memo takes effect. format: date type: string excludeFromAutoApplyRules: description: | Whether the credit memo is excluded from the rule of automatically applying credit memos to invoices. type: boolean invoiceId: description: | The ID of the invoice that the credit memo is created from. type: string items: description: | Container for items. The maximum number of items is 1,000. items: $ref: '#/components/schemas/CreditMemoItemFromInvoiceItemType' maxItems: 1000 type: array reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string taxAutoCalculation: default: true description: | Whether to automatically calculate taxes in the credit memo. type: boolean type: object required: - invoiceId - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' example: invoiceId: 8a90d7a892d82d920192dbcb314501c7 items: - amount: 10 invoiceItemId: 8a90d7a892d82d920192dbcb31f401c8 skuName: SKU-00000707 title: memos CreditMemoItemFromInvoiceItemType: allOf: - properties: amount: description: | The amount of the credit memo item. format: double type: number description: description: | The description of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string financeInformation: description: | Container for the finance information related to the credit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object invoiceItemId: description: | The ID of the invoice item. type: string quantity: description: | The number of units for the credit memo item. format: double type: number serviceEndDate: description: | The service end date of the credit memo item. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. format: date type: string skuName: description: | The name of the charge associated with the invoice. type: string taxItems: description: | Container for taxation items. items: $ref: '#/components/schemas/CreditMemoTaxItemFromInvoiceTaxItemType' type: array taxMode: default: TaxExclusive description: | The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax. **Note**: - Only includes the `taxMode` field if the credit memo needs to be processed with a different tax mode than what was processed during invoice generation or the product rate plan charge was defined with. Otherwise, do not specify a tax mode. - You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`. - If you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for credit memo items. The corresponding invoice item must use the same tax engine as the credit memo item to calculate tax amounts. enum: - TaxExclusive - TaxInclusive type: string unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string required: - skuName - amount - invoiceItemId type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items CreditMemoTaxItemFromInvoiceTaxItemType: properties: amount: description: | The amount of the credit memo taxation item. format: double type: number financeInformation: description: | Container for the finance information related to the source taxation item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string sourceTaxItemId: description: | The ID of the source taxation item. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format. format: date type: string taxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number taxName: description: | The name of taxation. type: string taxRate: description: | The tax rate applied to the credit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the credit memo. enum: - Percentage - FlatFee type: string title: taxItems type: object PUTBulkCreditMemosRequestType: allOf: - properties: memos: description: | The container for a list of credit memos. The maximum number of credit memos is 50. items: $ref: '#/components/schemas/PUTCreditMemosWithIdType' maxItems: 50 type: array type: object example: memos: - autoApplyUponPosting: false comment: new comment effectiveDate: '2017-04-17' excludeFromAutoApplyRules: false id: 402890555b797b57015b7986fc1a001f items: - amount: 1 comment: This is comment! id: 402890555b797b57015b7986fc1a001c quantity: 1 serviceEndDate: '2016-11-30' serviceStartDate: '2016-11-01' skuName: SKU-1 taxItems: - amount: 0.03 id: 402890555b797b57015b7986fc3c001d jurisdiction: CALIFORNIA locationCode: '06' taxCode: null taxCodeDescription: This is tax code description! taxDate: '2016-11-30' taxExemptAmount: 0 taxName: STATE TAX1 taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Test_UOM - amount: 2 comment: This is comment! id: 402890555b797b57015b7986fc41001e serviceEndDate: '2016-11-30' serviceStartDate: '2016-11-01' skuName: SKU-2 taxItems: [] unitOfMeasure: Test_UOM reasonCode: Correcting invoice error PUTCreditMemosWithIdType: allOf: - properties: id: description: | The ID of the credit memo. type: string type: object - $ref: '#/components/schemas/PUTCreditMemoType' title: memos PUTCreditMemoType: allOf: - properties: autoApplyUponPosting: description: | Whether the credit memo automatically applies to the invoice upon posting. type: boolean comment: description: | Comments about the credit memo. maxLength: 255 minLength: 0 type: string effectiveDate: description: | The date when the credit memo takes effect. format: date type: string excludeFromAutoApplyRules: description: | Whether the credit memo is excluded from the rule of automatically applying unapplied credit memos to invoices and debit memos during payment runs. If you set this field to `true`, a payment run does not pick up this credit memo or apply it to other invoices or debit memos. type: boolean items: description: | Container for credit memo items. items: $ref: '#/components/schemas/PUTCreditMemoItemType' type: array reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string transferredToAccounting: description: | Whether the credit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string type: object - $ref: '#/components/schemas/CreditMemoObjectNSFields' - $ref: '#/components/schemas/CreditMemoObjectCustomFields' example: comment: Details about this Credit Memo PUTCreditMemoItemType: allOf: - properties: amount: description: | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax format: double type: number comment: description: | Comments about the credit memo item. type: string delete: description: | Whether to delete the existing credit memo item. **Note**: To delete a credit memo item, set this field to `true` and specify a credit memo item ID in the `id` field. type: boolean excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the credit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object id: description: | The ID of the credit memo item. - Specify this field when updating or deleting an existing memo item. - Do not specify this field when creating a memo item. maxLength: 32 minLength: 32 type: string quantity: description: | The number of units for the credit memo item. format: double type: number productRatePlanChargeId: description: | The ID of the product rate plan charge that the credit memo is created from. **Note**: Do not specify the credit memo item `id` when specifying this field. type: string serviceEndDate: description: | The service end date of the credit memo item. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. format: date type: string skuName: description: | The name of the SKU. type: string taxItems: description: | Container for credit memo taxation items. items: $ref: '#/components/schemas/PutCreditMemoTaxItemType' type: array unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items PutCreditMemoTaxItemType: allOf: - properties: amount: description: | The amount of the taxation item in the credit memo item. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item in the credit memo item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object id: description: | The ID of the taxation item in the credit memo item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format. format: date type: string taxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number taxName: description: | The name of taxation. type: string taxRate: description: | The tax rate applied to the credit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the credit memo. enum: - Percentage - FlatFee type: string required: - id type: object - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields' title: taxItems CreditTaxationItemObjectCustomFields: additionalProperties: description: | Custom fields of the Credit Taxation Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Credit Taxation Item object. title: creditTaxationItemFieldsCustom type: object GetCreditMemoPdfStatusBatchResponse: description: '' example: creditMemoFiles: - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - creditMemoId: 2c98908a904dfc2601904e6e14090241 creditMemoNumber: CM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - creditMemoId: 402824aa8cc894d5018cc8a120576881 creditMemoNumber: CM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true properties: creditMemoFiles: description: | Array of credit memo PDF statuses requested. items: $ref: '#/components/schemas/GetCreditMemoPdfStatusResponse' type: array success: description: | Indicates whether the call succeeded. type: boolean type: object title: creditMemoFiles GetCreditMemoPdfStatusResponse: allOf: - properties: creditMemoId: description: | The ID of the credit memo whose pdf status is requested. type: string creditMemoNumber: description: | The credit memo number of the credit memo whose pdf status is requested. type: string pdfGenerationStatus: description: | The generation status of the credit memo PDF. type: string enum: - None - Pending - Processing - Generated - Error - Obsolete createdOn: description: | The time at which the request to generate the PDF was created. type: string updatedOn: description: | The time at which the request to generate the PDF was updated. type: string pdfFileURL: description: | The file path or the URL of the PDF when the status is `Generated`. type: string errorCategory: description: | The error category when the status is `Error`. type: string errorMessage: description: | The error message when the status is `Error`. type: string type: object GETTaxationItemsOfCreditMemoItemType: allOf: - properties: data: description: | Container for the taxation items of the credit memo item. items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETCMTaxItemTypeNew: allOf: - properties: appliedAmount: description: | The applied amount of the taxation item. format: double type: number exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. type: string nullable: true onAccountAccountingCodeType: description: | The type of the accounting code that maps to an on account in your accounting system. type: string nullable: true salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. type: string nullable: true salesTaxPayableAccountingCodeType: description: | The type of the accounting code for the sales taxes payable. type: string nullable: true type: object id: description: | The ID of the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of the taxation item. type: string refundAmount: description: | The amount of the refund on the taxation item. format: double type: number sourceTaxItemId: description: | The ID of the source taxation item. type: string nullable: true taxAmount: description: | The amount of taxation. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the credit memo, in `yyyy-mm-dd` format. format: date type: string taxRate: description: | The tax rate applied to the credit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate. enum: - Percentage - FlatFee type: string unappliedAmount: description: | The unapplied amount of the taxation item. format: double type: number type: object - $ref: '#/components/schemas/CreditTaxationItemObjectCustomFields' title: data PUTCreditMemoWriteOff: allOf: - properties: comment: description: | Comments about the debit memo. type: string memoDate: description: | The creation date of the debit memo and the effective date of the credit memo. Credit memos are applied to the corresponding debit memos on `memoDate`. By default, `memoDate` is set to the current date. format: date type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. The default value is `Write-off`. type: string type: object - $ref: '#/components/schemas/DebitMemoObjectCustomFieldsCMWriteOff' example: memoDate: '2022-05-05' PUTCreditMemoWriteOffResponseType: properties: debitMemo: description: | Container for the credit memo that is automatically created. properties: id: description: | The unique ID of the created debit memo. type: string type: object success: description: | Returns `true` if the request was processed successfully. type: boolean type: object DebitMemoObjectCustomFieldsCMWriteOff: additionalProperties: description: | Custom fields of the Debit Memo object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Debit Memo object. title: debitMemoFieldsCustom type: object ApplyCreditMemoType: example: effectiveDate: '2024-08-19' invoices: - invoiceId: 8ad097b490a1ec740190a5aaece25734 amount: 11 properties: debitMemos: description: | Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/CreditMemoApplyDebitMemoRequestType' type: array effectiveDate: description: | The date when the credit memo is applied. format: date type: string invoices: description: | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/CreditMemoApplyInvoiceRequestType' type: array type: object CreditMemoApplyDebitMemoRequestType: properties: amount: description: | The credit memo amount to be applied to the debit memo. format: double type: number debitMemoId: description: | The unique ID of the debit memo that the credit memo is applied to. type: string items: description: | Container for items. The maximum number of items is 1,000. If `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`. If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`. items: $ref: '#/components/schemas/CreditMemoApplyDebitMemoItemRequestType' type: array required: - amount - debitMemoId title: debitMemos type: object CreditMemoApplyInvoiceRequestType: properties: amount: description: | The credit memo amount to be applied to the invoice. format: double type: number invoiceId: description: | The unique ID of the invoice that the credit memo is applied to. type: string items: description: | Container for items. The maximum number of items is 1,000. If `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`. If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`. items: $ref: '#/components/schemas/CreditMemoApplyInvoiceItemRequestType' type: array required: - amount - invoiceId title: invoices type: object CreditMemoApplyInvoiceItemRequestType: properties: amount: description: | The amount that is applied to the specific item. format: double type: number creditMemoItemId: description: | The ID of the credit memo item. type: string creditTaxItemId: description: | The ID of the credit memo taxation item. type: string invoiceItemId: description: | The ID of the invoice item that the credit memo item is applied to. type: string taxItemId: description: | The ID of the invoice taxation item that the credit memo taxation item is applied to. type: string required: - amount title: items type: object CreditMemoApplyDebitMemoItemRequestType: properties: amount: description: | The amount that is applied to the specific item. format: double type: number creditMemoItemId: description: | The ID of the credit memo item. type: string creditTaxItemId: description: | The ID of the credit memo taxation item. type: string debitMemoItemId: description: | The ID of the debit memo item that the credit memo item is applied to. type: string taxItemId: description: | The ID of the debit memo taxation item that the credit memo taxation item is applied to. type: string required: - amount title: items type: object PostCreditMemoEmailRequestType: example: useEmailTemplateSetting: true properties: emailAddresses: description: | The valid email addresses you want to email a credit memo to. Use commas to separate email addresses. **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`. type: string includeAdditionalEmailAddresses: default: false description: | Indicates whether to send a credit memo to the additional email addresses of the memo account. You can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information. enum: - true - false type: boolean pdfFileId: description: | The ID of the PDF file that you want to send in the email. If you do not specify any PDF file ID, the latest PDF file generated for the credit memo is sent in the email. type: string useEmailTemplateSetting: default: false description: | Indicates whether to email a credit memo based on the email template setting. If you set this field to `true`, the credit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template. enum: - true - false type: boolean type: object GETCreditMemoFilesResponse: properties: creditMemoFiles: description: | Container for credit memo PDF files. items: $ref: '#/components/schemas/CreditMemoFile' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object CreditMemoFile: properties: id: description: | The ID of the credit memo PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID. type: string pdfFileUrl: description: | The relative URL of the credit memo PDF file. You can obtain the absolute URL for downloading the file by adding a prefix in the following format: `{environment_base_url}/apps` For example, `https://apisandbox.zuora.com/apps/v1/files/8a90a24f8e128020018e12cf610903f8`. type: string versionNumber: description: | The version number of the credit memo PDF file. format: int64 type: integer title: creditMemoFile type: object GETCreditMemoItemsListType: properties: items: description: | Container for credit memo items. items: $ref: '#/components/schemas/GETCreditMemoItemTypewithSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETCreditMemoItemTypewithSuccess: allOf: - properties: amount: description: | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax. format: double type: number amountWithoutTax: description: | The credit memo item amount excluding tax. format: double type: number appliedAmount: description: | The applied amount of the credit memo item. format: double type: number appliedToItemId: description: | The unique ID of the credit memo item that the discount charge is applied to. type: string createdById: description: | The ID of the Zuora user who created the credit memo item. type: string createdDate: description: | The date and time when the credit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditFromItemId: description: | The ID of the credit from item. type: string creditFromItemSource: description: | The type of the credit from item. enum: - InvoiceItem - CreditMemoItem type: string description: description: | The description of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the credit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. type: string deferredRevenueAccountingCodeType: description: | The type of the deferred revenue accounting code, such as Deferred Revenue. type: string nonRevenueWriteOffAccountingCode: description: | Specify the accounting code for the non revenue write off. Available only if `revenueImpacting` = `no`. type: string nonRevenueWriteOffAccountingCodeType: description: | Specify the accounting code type for the non revenue write off. type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. type: string onAccountAccountingCodeType: description: | The type of the accounting code that maps to an on account in your accounting system. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. type: string recognizedRevenueAccountingCodeType: description: | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. type: string revenueScheduleNumber: description: | Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001. type: string type: object id: description: | The ID of the credit memo item. type: string invoiceScheduleId: description: | The ID of the invoice schedule associated with the credit memo item. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string invoiceScheduleItemId: description: | The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string numberOfDeliveries: description: | The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows: - For the credit memo generated by a bill run, this field has a value. - For the credit memo generated from an invoice, this field is blank. **Note**: This field is available only if you have the Delivery Pricing feature enabled. type: number processingType: description: | The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. type: string quantity: description: | The number of units for the credit memo item. format: double type: number reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. refundAmount: description: | The amount of the refund on the credit memo item. format: double type: number revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. enum: - 'Yes' - 'No' default: 'Yes' type: string serviceEndDate: description: | The service end date of the credit memo item. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. format: date type: string sku: description: | The SKU for the product associated with the credit memo item. type: string skuName: description: | The name of the SKU. type: string shipToContactId: description: | The ID of the ship-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string soldToContactId: description: | The ID of the sold-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string sourceItemId: description: | The ID of the source item. - If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge. - If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item. - If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge. - If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item. type: string sourceItemType: description: | The type of the source item. - If a credit memo is not created from an invoice or a product rate plan charge or a return order line item, the value of this field is `SubscriptionComponent`. - If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`. - If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`. - If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`. enum: - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge - OrderLineItem type: string subscriptionId: description: | The ID of the subscription associated with the credit memo item. type: string taxMode: description: | The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax. enum: - TaxExclusive - TaxInclusive type: string taxationItems: description: | Container for the taxation items of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). properties: data: description: | List of taxation items. items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string type: object unappliedAmount: description: | The unapplied amount of the credit memo item. format: double type: number unitOfMeasure: description: | The units to measure usage. type: string unitPrice: description: | The per-unit price of the credit memo item. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the credit memo item. type: string updatedDate: description: | The date and time when the credit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items GETCreditMemoItemType: allOf: - properties: amount: description: | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax. format: double type: number amountWithoutTax: description: | The credit memo item amount excluding tax. format: double type: number appliedAmount: description: | The applied amount of the credit memo item. format: double type: number appliedToItemId: description: | The unique ID of the credit memo item that the discount charge is applied to. type: string nullable: true createdById: description: | The ID of the Zuora user who created the credit memo item. type: string createdDate: description: | The date and time when the credit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditFromItemId: description: | The ID of the credit from item. type: string creditFromItemSource: description: | The type of the credit from item. enum: - InvoiceItem - CreditMemoItem type: string description: description: | The description of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the credit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. type: string nullable: true deferredRevenueAccountingCodeType: description: | The type of the deferred revenue accounting code, such as Deferred Revenue.' type: string nullable: true nonRevenueWriteOffAccountingCode: description: | Specify the accounting code for the non revenue write off. Available only if `revenueImpacting` = `no`. type: string nullable: true nonRevenueWriteOffAccountingCodeType: description: | Specify the accounting code type for the non revenue write off. type: string nullable: true onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. type: string nullable: true onAccountAccountingCodeType: description: | The type of the accounting code that maps to an on account in your accounting system. type: string nullable: true recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. type: string nullable: true recognizedRevenueAccountingCodeType: description: | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. type: string nullable: true revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. type: string revenueScheduleNumber: description: | Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001. type: string type: object id: description: | The ID of the credit memo item. type: string invoiceScheduleId: description: | The ID of the invoice schedule associated with the credit memo item. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string invoiceScheduleItemId: description: | The ID of the invoice schedule item associated with the credit memo item. The credit memo item is generated during the processing of the invoice schedule item. **Note**: This field is available only if you have the Billing Schedule feature enabled. type: string numberOfDeliveries: description: | The number of deliveries dedicated to the Delivery Pricing charges. The value might be different, as follows: - For the credit memo generated by a bill run, this field has a value. - For the credit memo generated from an invoice, this field is blank. **Note**: This field is available only if you have the Delivery Pricing feature enabled. type: number organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string processingType: description: | The kind of the charge for the credit memo item. Its possible values are `Charge` and `Discount`. type: string quantity: description: | The number of units for the credit memo item. format: double type: number refundAmount: description: | The amount of the refund on the credit memo item. format: double type: number reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. enum: - 'Yes' - 'No' default: 'Yes' type: string serviceEndDate: description: | The service end date of the credit memo item. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. If the associated charge is a one-time fee, this date is the date of that charge. format: date type: string sku: description: | The SKU for the product associated with the credit memo item. type: string skuName: description: | The name of the SKU. type: string shipToContactId: description: | The ID of the ship-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string soldToContactId: description: | The ID of the sold-to contact associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the credit memo item. **Note**: If you have the Flexible Billing Attributes feature disabled, the value of this field is `null`. type: string sourceItemId: description: | The ID of the source item. - If the value of the `sourceItemType` field is `SubscriptionComponent` , the value of this field is the ID of the corresponding rate plan charge. - If the value of the `sourceItemType` field is `InvoiceDetail`, the value of this field is the ID of the corresponding invoice item. - If the value of the `sourceItemType` field is `ProductRatePlanCharge` , the value of this field is the ID of the corresponding product rate plan charge. - If the value of the `sourceItemType` field is `OrderLineItem` , the value of this field is the ID of the corresponding return order line item. type: string sourceItemType: description: | The type of the source item. - If a credit memo is not created from an invoice or a product rate plan charge or a return order line item,, the value of this field is `SubscriptionComponent`. - If a credit memo is created from an invoice, the value of this field is `InvoiceDetail`. - If a credit memo is created from a product rate plan charge, the value of this field is `ProductRatePlanCharge`. - If a credit memo is created from a return order line item, the value of this field is `OrderLineItem`. enum: - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge - OrderLineItem type: string subscriptionId: description: | The ID of the subscription associated with the credit memo item. type: string success: description: Returns `true` if the request was processed successfully. type: boolean taxMode: description: | The tax mode of the credit memo item, indicating whether the amount of the credit memo item includes tax. enum: - TaxExclusive - TaxInclusive type: string taxationItems: description: | Container for the taxation items of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). properties: data: description: | List of taxation items. items: $ref: '#/components/schemas/GETCMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string type: object unappliedAmount: description: | The unapplied amount of the credit memo item. format: double type: number unitOfMeasure: description: | The units to measure usage. type: string unitPrice: description: | The per-unit price of the credit memo item. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the credit memo item. type: string updatedDate: description: | The date and time when the credit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' GETCreditMemoPartsCollectionType: properties: nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string parts: description: | Container for credit memo parts. items: $ref: '#/components/schemas/GETCreditMemoPartTypewithSuccess' type: array success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETCreditMemoPartTypewithSuccess: properties: amount: description: | The amount of the credit memo part. format: double type: number createdById: description: | The ID of the Zuora user who created the credit memo part. type: string createdDate: description: | The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoId: description: | The ID of the debit memo associated with the credit memo part. type: string id: description: | The ID of the credit memo part. type: string invoiceId: description: | The ID of the invoice associated with the credit memo part. type: string updatedById: description: | The ID of the Zuora user who last updated the credit memo part. type: string updatedDate: description: | The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string title: parts type: object GETCreditMemoPartType: properties: amount: description: | The amount of the credit memo part. format: double type: number createdById: description: | The ID of the Zuora user who created the credit memo part. type: string createdDate: description: | The date and time when the credit memo part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoId: description: | The ID of the debit memo associated with the credit memo part. type: string id: description: | The ID of the credit memo part. type: string invoiceId: description: | The ID of the invoice associated with the credit memo part. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string success: description: Returns `true` if the request was processed successfully. type: boolean updatedById: description: | The ID of the Zuora user who last updated the credit memo part. type: string updatedDate: description: | The date and time when the credit memo part was last upated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object POSTMemoPdfResponse: properties: success: description: | Returns `true` if the request was processed successfully. type: boolean type: object PostNonRefRefundType: allOf: - properties: comment: description: | Comments about the refund. maxLength: 255 minLength: 0 type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both). **Note**: - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `224.0` or a later version. - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. items: $ref: '#/components/schemas/CreditMemoFromChargeCustomRatesType' maxItems: 2 type: array financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. maxLength: 100 minLength: 0 type: string onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. maxLength: 100 minLength: 0 type: string type: object gatewayId: description: | The ID of the gateway instance that processes the refund. This field can be specified only for electronic refunds. The ID must be a valid gateway instance ID, and this gateway must support the specific payment method. If no gateway ID is specified, the default gateway in the billing account configuration will be used. If no gateway is specified in the billing account, the default gateway of the corresponding tenant will be used. type: string gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object items: description: | Container for credit memo items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/RefundCreditMemoItemType' type: array methodType: description: | How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on a credit memo. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string paymentMethodId: description: | The ID of the payment method used for the refund. This field is required for an electronic refund, and the value must be an electronic payment method ID. This field must be left empty for an external refund. type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string refundDate: description: | The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the credit memo date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds. format: date type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string softDescriptor: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 35 type: string softDescriptorPhone: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 20 type: string totalAmount: description: | The total amount of the refund. The amount cannot exceed the unapplied amount of the associated credit memo. If the original credit memo was applied to one or more invoices or debit memos, you have to unapply a full or partial credit memo from the invoices or debit memos, and then refund the full or partial unapplied credit memo to your customers. format: double type: number type: description: | The type of the refund. enum: - External - Electronic type: string required: - totalAmount - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' example: type: Electronic totalAmount: 10 paymentMethodId: 8ad084db90a5e73b0190c02783f552fa GETRefundCreditMemoType: allOf: - properties: accountId: description: | The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment. type: string amount: description: | The total amount of the refund. format: double type: number cancelledOn: description: | The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the refund. type: string nullable: true createdById: description: | The ID of the Zuora user who created the refund. type: string createdDate: description: | The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-06 15:31:10. format: date-time type: string creditMemoId: description: | The ID of the credit memo that is refunded. type: string financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string nullable: true bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string nullable: true transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string nullable: true unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string nullable: true type: object gatewayId: description: | The ID of the gateway instance that processes the refund. type: string gatewayResponse: description: | The message returned from the payment gateway for the refund. This message is gateway-dependent. type: string gatewayResponseCode: description: | The response code returned from the payment gateway for the refund. This code is gateway-dependent. type: string gatewayState: description: | The status of the refund in the gateway. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The ID of the created refund. type: string markedForSubmissionOn: description: | The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true methodType: description: | How an external refund was issued to a customer. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: description: | The unique identification number of the refund. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentId: description: | The ID of the payment associated with the refund. type: string nullable: true paymentMethodId: description: | The unique ID of the payment method that the customer used to make the refund. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. type: string reasonCode: description: | A code identifying the reason for the transaction. type: string nullable: true referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. type: string refundDate: description: | The date when the refund takes effect, in yyyy-mm-dd format. format: date type: string refundTransactionTime: description: | The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true settledOn: description: | The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string nullable: true softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true status: description: | The status of the refund. enum: - Processed - Canceled - Error - Processing type: string submittedOn: description: | The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: description: | The type of the refund. enum: - External - Electronic type: string updatedById: description: | The ID of the Zuora user who last updated the refund. type: string updatedDate: description: | The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-07 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' RefundObjectNSFields: description: | Container for Refund fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the refund's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Origin__NS: description: | Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the refund was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SynctoNetSuite__NS: description: | Specifies whether the refund should be synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: refundFieldsNS type: object RefundObjectCustomFields: additionalProperties: description: | Custom fields of the Refund object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Refund object. title: refundFieldsCustom type: object RefundCreditMemoItemType: properties: amount: description: | The amount of the refund on the specific item. format: double type: number creditMemoItemId: description: | The ID of the credit memo item that is refunded. type: string creditTaxItemId: description: | The ID of the credit memo taxation item that is refunded. type: string required: - amount title: items type: object PutReverseCreditMemoType: example: applyEffectiveDate: '2017-02-20' memoDate: '2017-02-20' properties: applyEffectiveDate: description: | The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in `yyyy-mm-dd` format. The effective date must be later than or equal to the memo date. The default value is the date when you reverse the credit memo and create the debit memo. format: date type: string comment: description: | Comments about the reversal. The comment is used as the comment of the debit memo generated by reversing the specified credit memo. maxLength: 255 minLength: 0 type: string memoDate: description: | The date when the debit memo is created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the credit memo's memo date. The default value is the date when you reverse the credit memo and create the debit memo. format: date type: string reasonCode: description: | A code identifying the reason for the reversal. The value must be an existing reason code or empty. The code is used as the reason code of the debit memo generated by reversing the specified credit memo. If you do not specify a value, Zuora uses the default reason code `Credit memo reversal` for the debit memo. type: string type: object PutReverseCreditMemoResponseType: properties: creditMemo: description: | Container for the credit memo that is automatically generated during the reversal of the invoice that is related to the credit memo. If no related invoice is reversed, the value is null. properties: id: description: The ID of the credit memo. type: string type: object debitMemo: description: | Container for the debit memo that is automatically generated during the credit memo reversal. properties: id: description: The ID of the debit memo. type: string type: object success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTTaxationItemListForCMType: example: taxationItems: - name: STATE TAX memoItemId: 8ad086fa932a0b5401932e82ab1f1fb3 jurisdiction: CALIFORNIA taxAmount: 0.5 taxCode: ServiceTaxCode taxDate: '2024-11-15' taxRate: 0.05 taxRateType: Percentage properties: taxationItems: description: | Container for taxation items. items: $ref: '#/components/schemas/POSTTaxationItemForCMType' type: array type: object POSTTaxationItemForCMType: allOf: - properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string memoItemId: description: | The ID of the credit memo that the taxation item is created for. type: string name: description: | The name of the taxation item. type: string sourceTaxItemId: description: | The ID of the taxation item of the invoice, which the credit memo is created from. If you want to use this REST API to create taxation items for a credit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call. **Note:** - This field is only used if the credit memo is created from an invoice. - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate. type: string taxAmount: description: | The amount of the tax applied to the credit memo. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date when the tax is applied to the credit memo. format: date type: string taxRate: description: | The tax rate applied to the credit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the credit memo. enum: - Percentage - FlatFee type: string required: - taxRate - jurisdiction - name - taxRateType - taxAmount type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems UnapplyCreditMemoType: example: effectiveDate: '2024-10-30' invoices: - invoiceId: 8a90acec910816f601910bcf57a62363 amount: 1 properties: debitMemos: description: | Container for debit memos that the credit memo is unapplied from. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoRequestType' type: array effectiveDate: description: | The date when the credit memo is unapplied. format: date type: string invoices: description: | Container for invoices that the credit memo is unapplied from. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/CreditMemoUnapplyInvoiceRequestType' type: array type: object CreditMemoUnapplyDebitMemoRequestType: properties: amount: description: | The credit memo amount to be unapplied from the debit memo. format: double type: number debitMemoId: description: | The unique ID of the debit memo that the credit memo is unapplied from. type: string items: description: | Container for items. The maximum number of items is 1,000. items: $ref: '#/components/schemas/CreditMemoUnapplyDebitMemoItemRequestType' type: array required: - amount - debitMemoId title: debitMemos type: object CreditMemoUnapplyInvoiceRequestType: properties: amount: description: | The credit memo amount to be unapplied from the invoice. format: double type: number invoiceId: description: | The unique ID of the invoice that the credit memo is unapplied from. type: string items: description: | Container for items. The maximum number of items is 1,000. items: $ref: '#/components/schemas/CreditMemoUnapplyInvoiceItemRequestType' type: array required: - amount - invoiceId title: invoices type: object CreditMemoUnapplyInvoiceItemRequestType: properties: amount: description: | The amount that is unapplied from the specific item. format: double type: number creditMemoItemId: description: | The ID of the credit memo item. type: string creditTaxItemId: description: | The ID of the credit memo taxation item. type: string invoiceItemId: description: | The ID of the invoice item that the credit memo item is unapplied from. type: string taxItemId: description: | The ID of the invoice taxation item that the credit memo taxation item is unapplied from. type: string required: - amount title: items type: object CreditMemoUnapplyDebitMemoItemRequestType: properties: amount: description: | The amount that is unapplied from the specific item. format: double type: number creditMemoItemId: description: | The ID of the credit memo item. type: string creditTaxItemId: description: | The ID of the credit memo taxation item. type: string debitMemoItemId: description: | The ID of the debit memo item that the credit memo item is unapplied from. type: string taxItemId: description: | The ID of the debit memo taxation item that the credit memo taxation item is unapplied from. type: string required: - amount title: items type: object InvoiceSettlementAsyncJobResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: id: description: The ID of the operation job. type: string status: $ref: '#/components/schemas/InvoiceSettlementAsyncJobStatus' operationType: $ref: '#/components/schemas/InvoiceSettlementAsyncJobOperationType' referenceId: description: The ID of the business object which is being operated. type: string referenceType: $ref: '#/components/schemas/InvoiceSettlementAsyncJobReferenceType' error: description: The error message if the operation error out. type: string type: object InvoiceSettlementAsyncJobStatus: enum: - Pending - Processing - Processed - Error type: string description: | Job status of the Invoice Settlement async job. InvoiceSettlementAsyncJobOperationType: enum: - AsyncCreditMemoApply - AsyncCreditMemoUnapply type: string description: | Operation type of the Invoice Settlement async job. InvoiceSettlementAsyncJobReferenceType: enum: - CreditMemo type: string description: | Reference type of the Invoice Settlement async job. AsyncApplyCreditMemoRequest: example: effectiveDate: '2017-03-02' invoices: - amount: 1 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 properties: effectiveDate: description: | The date when the credit memo is applied. format: date type: string invoices: description: | Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/AsyncApplyCreditMemoToInvoice' type: array type: object AsyncApplyCreditMemoToInvoice: properties: amount: description: | The credit memo amount to be applied to the invoice. type: number invoiceId: description: | The unique ID of the invoice that the credit memo is applied to. type: string required: - amount - invoiceId title: AppliedInvoice type: object AsyncUnapplyCreditMemoRequest: example: effectiveDate: '2017-03-02' invoices: - amount: 1 invoiceId: 4028905f5a87c0ff015a87d3f8f10043 properties: effectiveDate: description: | The date when the credit memo is unapplied. format: date type: string invoices: description: | Container for invoices that the credit memo is unapplied. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/AsyncUnapplyCreditMemoToInvoice' type: array type: object AsyncUnapplyCreditMemoToInvoice: properties: amount: description: | The credit memo amount to be unapplied from the invoice. type: number invoiceId: description: | The unique ID of the invoice that the credit memo is unapplied from. type: string required: - amount - invoiceId title: UnappliedInvoice GETDebitMemoCollectionType: properties: debitmemos: description: | Container for debit memos. items: $ref: '#/components/schemas/GETDebitMemoTypewithSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETDebitMemoTypewithSuccess: allOf: - properties: accountId: description: | The ID of the customer account associated with the debit memo. type: string accountNumber: description: | The number of the customer account associated with the debit memo. type: string amount: description: | The total amount of the debit memo. format: double type: number autoPay: description: | Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. type: boolean balance: description: | The balance of the debit memo. format: double type: number beAppliedAmount: description: | The applied amount of the debit memo. format: double type: number billToContactId: description: | The ID of the bill-to contact associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string cancelledById: description: | The ID of the Zuora user who cancelled the debit memo. type: string nullable: true cancelledOn: description: | The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the debit memo. type: string nullable: true createdById: description: | The ID of the Zuora user who created the debit memo. type: string createdDate: description: | The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string currency: type: string description: | The currency of the debit memo. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. nullable: true debitMemoDate: description: | The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20. format: date type: string dueDate: description: | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. format: date type: string einvoiceErrorCode: description: | The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceErrorMessage: description: | The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceFileId: description: | The ID of the e-invoice file generated for the debit memo. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceStatus: description: | The status of the e-invoice file generation for the debit memo. - If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true id: description: | The unique ID of the debit memo. type: string invoiceGroupNumber: description: | The number of the invoice group associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true latestPDFFileId: description: | The ID of the latest PDF file generated for the debit memo. type: string number: description: | The unique identification number of the debit memo. type: string paymentTerm: description: | The name of the payment term associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true postedById: description: | The ID of the Zuora user who posted the debit memo. type: string nullable: true postedOn: description: | The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. type: string referredCreditMemoId: description: | The ID of the credit memo from which the debit memo was created. type: string nullable: true referredInvoiceId: description: | The ID of a referred invoice. type: string nullable: true sequenceSetId: description: | The ID of the sequence set associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the debit memo. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true sourceType: description: | The type of the debit memo source. enum: - Subscription - Standalone - Order - Consolidation - Invoice - CreditMemo type: string status: description: | The status of the debit memo. enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string targetDate: description: | The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20. format: date type: string nullable: true taxAmount: description: | The amount of taxation. format: double type: number taxMessage: description: | The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure. type: string nullable: true taxStatus: description: | The status of tax calculation related to the debit memo. **Note**: This field is only applicable to tax calculation by third-party tax engines. Also, the `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number transferredToAccounting: description: | Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string updatedById: description: | The ID of the Zuora user who last updated the debit memo. type: string updatedDate: description: | The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:31:10. format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: debitmemos DebitMemoObjectNSFields: description: | Container for Debit Memo fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: debitMemoFieldsNS type: object DebitMemoObjectCustomFields: additionalProperties: description: | Custom fields of the Debit Memo object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Debit Memo object. title: debitMemoFieldsCustom type: object DebitMemoFromChargeRequest: allOf: - properties: accountId: description: | The ID of the account associated with the debit memo. **Note**: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string accountNumber: description: | The number of the account associated with the debit memo. **Note**: When creating debit memos from product rate plan charges, you must specify `accountNumber`, `accountId`, or both in the request body. If both fields are specified, they must correspond to the same account. type: string autoPay: description: | Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. type: boolean autoPost: default: false description: | Whether to automatically post the debit memo after it is created. Setting this field to `true`, you do not need to separately call the [Post a debit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo. type: boolean charges: description: | Container for product rate plan charges. The maximum number of items is 1,000. items: $ref: '#/components/schemas/DebitMemoFromChargeDetailType' maxItems: 1000 type: array comment: description: | Comments about the debit memo. maxLength: 255 minLength: 0 type: string currency: description: | The code of a currency as defined in Billing Settings through the Zuora UI. If you do not specify a currency during debit memo creation, the default account currency is applied. The currency that you specify in the request must be configured and activated in Billing Settings. **Note**: This field is available only if you have the Multiple Currencies feature enabled. type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both). **Note**: - The API custom rate feature is permission controlled. - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. - DebitMemo, DebitMemoItem, and DebitMemoItemTax will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency. items: $ref: '#/components/schemas/DebitMemoFromChargeCustomRatesType' maxItems: 2 type: array dueDate: description: | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. format: date type: string effectiveDate: description: | The date when the debit memo takes effect. format: date type: string number: type: string maxLength: 32 description: | A customized debit memo number with the following format requirements: - Max length: 32 characters - Acceptable characters: a-z,A-Z,0-9,-,_ The value must be unique in the system, otherwise it may cause issues with bill runs and subscriptions. If not provided, Zuora will generate a unique number per the sequence set on the account level. If the account-level sequence set is not specified, the system default sequence set is used. For more information, see Configure prefix and numbering for billing documents. reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' example: accountId: 8ad09be48db5aba7018db604776d4854 charges: - amount: 10 productRatePlanChargeId: 8ad097b4909708e001909b41bb085d38 title: memos GETDebitMemoType: allOf: - properties: accountId: description: | The ID of the customer account associated with the debit memo. type: string accountNumber: description: | The number of the customer account associated with the debit memo. type: string amount: description: | The total amount of the debit memo. format: double type: number autoPay: description: | Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. type: boolean balance: description: | The balance of the debit memo. format: double type: number beAppliedAmount: description: | The amount that is applied to the debit memo. format: double type: number billToContactId: description: | The ID of the bill-to contact associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string billToContactSnapshotId: description: | The ID of the bill-to contact snapshot associated with the debit memo. The value of this field is `null` if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled. type: string cancelledById: description: | The ID of the Zuora user who cancelled the debit memo. type: string nullable: true cancelledOn: description: | The date and time when the debit memo was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true currency: description: | The currency of the debit memo. **Note:** By default, the currency on a billing document matches the default currency set on the associated account. However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. For more information, see Multiple Currency. type: string nullable: true comment: description: | Comments about the debit memo. type: string nullable: true createdById: description: | The ID of the Zuora user who created the debit memo. type: string createdDate: description: | The date and time when the debit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoDate: description: | The date when the debit memo takes effect, in `yyyy-mm-dd` format. For example, 2017-05-20. format: date type: string dueDate: description: | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. format: date type: string einvoiceErrorCode: description: | The error code returned when the e-invoice file status is `Failed`. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceErrorMessage: description: | The error message returned when the e-invoice file status is `Failed`. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceFileId: description: | The ID of the e-invoice file generated for the debit memo. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. type: string nullable: true einvoiceStatus: description: | The status of the e-invoice file generation for the debit memo. - If e-invoice file generation succeeds, this field is either `Generated` or `Success`, and both the error code and message are empty, and the `eInvoiceFileId` field stores the ID of the generated e-invoice file. - If the responses from tax vendors such as Sovos or Avalara are taking too long, this field becomes `RetrieveTimeOut`. Once the vendor responds successfully, you can use the 'Resync E-Invoice Status' action to update the status automatically. You can view these updates in System Health telemetry. - If a failure occurs during e-invoice file generation, this field is `Failed` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If e-invoice file generation conditionally succeeds, this field is `ConditionalSuccess` and an error code and an error message are returned respectively in the `einvoiceErrorCode` and `einvoiceErrorMessage` fields. - If the e-invoice file has been approved by the tax authority, this field is `ApprovedByAuthority`. The next status will be either `Success` or `Rejected`. - If the e-invoice file has been rejected by the government, this field is `Rejected`. You cannot resend this e-invoice; you must create a new invoice instead. **Note**: This field is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. enum: - Processing - RetrieveTimeOut - Generated - Success - Failed - ConditionalSuccess - ApprovedByAuthority - Rejected type: string nullable: true excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean id: description: | The unique ID of the debit memo. type: string invoiceGroupNumber: description: | The number of the invoice group associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true latestPDFFileId: description: | The ID of the latest PDF file generated for the debit memo. type: string number: description: | The unique identification number of the debit memo. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentTerm: description: | The name of the payment term assoicated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string postedById: description: | The ID of the Zuora user who posted the debit memo. type: string nullable: true postedOn: description: | The date and time when the debit memo was posted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. type: string referredCreditMemoId: description: | The ID of the credit memo from which the debit memo was created. type: string referredInvoiceId: description: | The ID of a referred invoice. type: string nullable: true sequenceSetId: description: | The ID of the sequence set associated with the debit memo. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string nullable: true communicationProfileId: description: | The ID of the communication profile associated with the debit memo. **Note**: This field is available in the request body only if you have the Flexible Billing Attributes feature turned on. The value is `null` in the response body without this feature turned on. type: string nullable: true soldToContactId: description: | The ID of the sold-to contact associated with the debit memo. The value of this field is `null` if you have the Flexible Billing Attributes feature disabled. type: string nullable: true soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the debit memo. The value of this field is `null` if you have the Flexible Billing Attributes feature disabled. type: string nullable: true sourceType: description: | The type of the debit memo source. enum: - Subscription - Standalone - Order - Consolidation - Invoice - CreditMemo type: string status: description: | The status of the debit memo. enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string success: description: Returns `true` if the request was processed successfully. type: boolean targetDate: description: | The target date for the debit memo, in `yyyy-mm-dd` format. For example, 2017-07-20. format: date type: string nullable: true taxAmount: description: | The amount of taxation. format: double type: number taxMessage: description: | The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure. type: string nullable: true taxStatus: description: | The status of tax calculation related to the debit memo. **Note**: This field is only applicable to tax calculation by third-party tax engines. Also, the `Voided` status indicates that the tax transaction is successfully canceled on the tax vendor's side. If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side. enum: - Complete - Error - UnknownError - DuplicateDoc - InvalidRequest - InvalidResponse - TaxEngineError - ConcurrentModify - InternalServerError - TaxCodeTemplateError - Voided type: string nullable: true totalTaxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number transferredToAccounting: description: | Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string updatedById: description: | The ID of the Zuora user who last updated the debit memo. type: string updatedDate: description: | The date and time when the debit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' title: memos DebitMemoFromChargeDetailType: allOf: - properties: amount: description: | The amount of the debit memo item. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: double type: number excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean description: description: | The description of the product rate plan charge. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). maxLength: 255 minLength: 0 type: string financeInformation: description: | Container for the finance information related to the product rate plan charge associated with the debit memo. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string nullable: true recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string nullable: true revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string nullable: true type: object productRatePlanChargeId: description: | The ID of the product rate plan charge that the debit memo is created from. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string quantity: description: | The number of units for the debit memo item. format: double type: number serviceEndDate: description: | The service end date of the debit memo item. If not specified, the effective end date of the corresponding product rate plan will be used. format: date type: string serviceStartDate: description: | The service start date of the debit memo item. If not specified, the effective start date of the corresponding product rate plan will be used. format: date type: string required: - productRatePlanChargeId type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: charges DebitMemoFromChargeCustomRatesType: allOf: - properties: currency: description: | The currency code for either Reporting or Home currency. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string customFxRate: description: | The Custom FX conversion rate between home currency and transactional currency items. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: decimal type: number rateDate: description: | The date on which a particular currency rate is fixed or obtained on. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string required: - currency - customFxRate type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: customRates DebitMemoItemObjectCustomFields: additionalProperties: description: | Custom fields of the Debit Memo Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Debit Memo Item object. title: debitMemoItemFieldsCustom type: object PUTBatchDebitMemosRequest: example: debitMemos: - dueDate: '2017-12-28' id: 402890d25f9f083f015f9f28041d0008 - dueDate: '2017-12-20' id: 402890555a87d7f5015a892f2ba10057 properties: debitMemos: description: | Container for debit memo update details. items: $ref: '#/components/schemas/BatchDebitMemoType' type: array type: object BatchDebitMemoType: properties: dueDate: description: | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. format: date type: string id: description: | The unique ID or number of the debit memo to be updated. For example, 402890555a87d7f5015a892f2ba10057 or or DM00000001. type: string title: debitMemos type: object POSTBulkDebitMemosRequestType: discriminator: propertyName: sourceType mapping: Invoice: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest' Standalone: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest' oneOf: - $ref: '#/components/schemas/BulkCreateDebitMemosFromInvoiceRequest' - $ref: '#/components/schemas/BulkCreateDebitMemosFromChargeRequest' BulkDebitMemosResponseType: allOf: - properties: memos: description: | The container for a list of debit memos. items: $ref: '#/components/schemas/GETDebitMemoType' maxItems: 50 type: array success: description: Returns `true` if the request was processed successfully. type: boolean type: object BulkCreateDebitMemosFromInvoiceRequest: properties: sourceType: type: string enum: - Invoice description: | The type of the source where debit memos are created. This enum field has the following values: - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices. - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges. The specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field. - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list. - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list. memos: description: | The container for a list of debit memos. The maximum number of debit memos is 50. items: $ref: '#/components/schemas/DebitMemoFromInvoiceRequest' maxItems: 50 type: array required: - sourceType type: object BulkCreateDebitMemosFromChargeRequest: properties: sourceType: type: string enum: - Standalone description: | The type of the source where debit memos are created. This enum field has the following values: - `Invoice`: By setting this field to `Invoice`, you can create multiple debit memos from invoices. - `Standalone`: By setting this field to `Standalone`, you can create multiple debit memos from product rate plan charges. The specific schema of the `memos` object field in the request body depends on the value of the `sourceType` field. - To view the `memos` schema applicable to debit memo creation from invoices, select `Invoice` from the following drop-down list. - To view the `memos` schema applicable to debit memo creation from product rate plan charges, select `Standalone` from the following drop-down list. memos: description: | The container for a list of debit memos. The maximum number of debit memos is 50. items: $ref: '#/components/schemas/DebitMemoFromChargeRequest' maxItems: 50 type: array required: - sourceType type: object DebitMemoFromInvoiceRequest: allOf: - properties: autoPay: description: | Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. type: boolean autoPost: default: false description: | Whether to automatically post the debit memo after it is created. Setting this field to `true`, you do not need to separately call the [Post debit memo](https://developer.zuora.com/api-references/api/operation/PUT_PostDebitMemo) operation to post the debit memo. type: boolean billToContactId: description: | The ID of the bill-to contact associated with the debit memo. **Note**: This field is available only if you have Flexible Billing Attributes enabled for your tenant. type: string comment: description: | Comments about the debit memo. maxLength: 255 minLength: 0 type: string effectiveDate: description: | The date when the debit memo takes effect. format: date type: string invoiceId: description: | The ID of the invoice that the debit memo is created from. type: string items: description: | Container for items. The maximum number of items is 1,000. items: $ref: '#/components/schemas/DebitMemoItemFromInvoiceItemType' maxItems: 1000 type: array reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string soldToContactId: description: | The ID of the sold-to contact associated with the debit memo. **Note**: This field is available only if you have Flexible Billing Attributes enabled for your tenant. type: string soldToSameAsBillTo: description: | Whether the sold-to contact and bill-to contact are the same entity. The created debit memo has the same bill-to contact and sold-to contact entity only when all the following conditions are met in the request body: - This field is set to `true`. - The `billToContactId` field is specified. - The `soldToContactId` field is not specified. type: boolean taxAutoCalculation: default: true description: | Whether to automatically calculate taxes in the debit memo. type: boolean type: object required: - invoiceId - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' example: invoiceId: 8a90cc5c9301541f01930186636b1400 effectiveDate: '2024-11-11' items: - amount: 10 invoiceItemId: 8a90cc5c9301541f0193018663aa1413 skuName: SKU-00000591 reasonCode: Correcting invoice error title: memos DebitMemoItemFromInvoiceItemType: allOf: - properties: amount: description: | The amount of the debit memo item. format: double type: number description: description: | The description of the debit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or a later available version. type: string financeInformation: description: | Container for the finance information related to the debit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object invoiceItemId: description: | The ID of the invoice item. type: string quantity: description: | The number of units for the debit memo item. format: double type: number serviceEndDate: description: | The service end date of the debit memo item. format: date type: string serviceStartDate: description: | The service start date of the debit memo item. format: date type: string skuName: description: | The name of the charge associated with the invoice. type: string taxItems: description: | Container for taxation items. items: $ref: '#/components/schemas/DebitMemoTaxItemFromInvoiceTaxItemType' type: array taxMode: default: TaxExclusive description: | The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax. **Note**: You can set this field to `TaxInclusive` only if the `taxAutoCalculation` field is set to `true`. If you set `taxMode` to `TaxInclusive`, you cannot input tax amounts for debit memo items. The corresponding invoice item must use the same tax engine as the debit memo item to calculate tax amounts. enum: - TaxExclusive - TaxInclusive type: string unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string required: - skuName - amount type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items DebitMemoTaxItemFromInvoiceTaxItemType: properties: amount: description: | The amount of the debit memo taxation item. format: double type: number financeInformation: description: | Container for the finance information related to the source taxation item. properties: salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string sourceTaxItemId: description: | The ID of the source taxation item. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format. format: date type: string taxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number taxName: description: | The name of taxation. type: string taxRate: description: | The tax rate applied to the debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the debit memo. enum: - Percentage - FlatFee type: string required: - amount title: taxItems type: object PUTBulkDebitMemosRequestType: allOf: - properties: memos: description: | The container for a list of debit memos. The maximum number of debit memos is 50. items: $ref: '#/components/schemas/PUTDebitMemoWithIdType' maxItems: 50 title: memos type: array type: object example: memos: - autoPay: true comment: new comment dueDate: '2017-05-20' effectiveDate: '2017-04-17' id: 4028905f5a890526015a8db30954007a items: - amount: 1 comment: This is comment! id: 402890555b797b57015b7986fc1a001c quantity: 1 serviceEndDate: '2016-11-30' serviceStartDate: '2016-11-01' skuName: SKU-1 taxItems: - amount: 0.03 id: 402890555b797b57015b7986fc3c001d jurisdiction: CALIFORNIA locationCode: '06' taxCode: null taxCodeDescription: This is tax code description! taxDate: '2016-11-30' taxExemptAmount: 0 taxName: STATE TAX1 taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Test_UOM - amount: 2 comment: This is comment! id: 402890555b797b57015b7986fc41001e serviceEndDate: '2016-11-30' serviceStartDate: '2016-11-01' skuName: SKU-2 taxItems: - amount: 0.06 id: 402890555b797b57015b7986fc4c001f jurisdiction: CALIFORNIA locationCode: '06' taxCode: null taxCodeDescription: This is tax code description! taxDate: '2016-11-30' taxExemptAmount: 0 taxName: STATE TAX2 taxRate: 0.0625 taxRateDescription: This is tax rate description! taxRateType: Percentage unitOfMeasure: Test_UOM reasonCode: Correcting invoice error PUTDebitMemoWithIdType: allOf: - properties: id: description: | The ID of the debit memo. type: string type: object - $ref: '#/components/schemas/PUTDebitMemoType' PUTDebitMemoType: allOf: - properties: autoPay: description: | Whether debit memos are automatically picked up for processing in the corresponding payment run. By default, debit memos are automatically picked up for processing in the corresponding payment run. type: boolean comment: description: | Comments about the debit memo. maxLength: 255 minLength: 0 type: string dueDate: description: | The date by which the payment for the debit memo is due, in `yyyy-mm-dd` format. format: date type: string effectiveDate: description: | The date when the debit memo takes effect. format: date type: string items: description: | Container for debit memo items. items: $ref: '#/components/schemas/PUTDebitMemoItemType' type: array reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code type: string transferredToAccounting: description: | Whether the debit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string type: object - $ref: '#/components/schemas/DebitMemoObjectNSFields' - $ref: '#/components/schemas/DebitMemoObjectCustomFields' example: comment: Details about this Debit Memo PUTDebitMemoItemType: allOf: - properties: amount: description: | The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax. format: double type: number comment: description: | Comments about the debit memo item. type: string delete: description: | Whether to delete the existing debit memo item. **Note**: To delete a debit memo item, set this field to `true` and specify a debit memo item ID in the `id` field. type: boolean excludeItemBillingFromRevenueAccounting: default: false description: | The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the debit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. maxLength: 100 minLength: 0 type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. maxLength: 100 minLength: 0 type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. maxLength: 100 minLength: 0 type: string type: object id: description: | The ID of the debit memo item. - Specify this field when updating or deleting an existing memo item. - Do not specify this field when creating a memo item. maxLength: 32 minLength: 32 type: string productRatePlanChargeId: description: | The ID of the product rate plan charge that the debit memo is created from. **Note**: Do not specify the debit memo item `id` when specifying this field. type: string quantity: description: | The number of units for the debit memo item. format: double type: number serviceEndDate: description: | The service end date of the debit memo item. format: date type: string serviceStartDate: description: | The service start date of the debit memo item. format: date type: string skuName: description: | The name of the SKU. type: string taxItems: description: | Container for debit memo taxation items. items: $ref: '#/components/schemas/PutDebitMemoTaxItemType' type: array unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items PutDebitMemoTaxItemType: allOf: - properties: amount: description: | The amount of the taxation item in the debit memo item. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item in the debit memo item. properties: salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object id: description: | The ID of the taxation item in the debit memo item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format. format: date type: string taxExemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number taxName: description: | The name of taxation. type: string taxRate: description: | The tax rate applied to the debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the debit memo. enum: - Percentage - FlatFee type: string required: - id type: object - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields' title: taxItems DebitTaxationItemObjectCustomFields: additionalProperties: description: | Custom fields of the Debit Taxation Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Debit Taxation Item object. title: debitTaxationItemFieldsCustom type: object GetDebitMemoPdfStatusBatchResponse: description: '' example: debitMemoFiles: - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000003 pdfGenerationStatus: Generated createdOn: '2024-01-01 11:32:19' updatedOn: '2024-01-01 11:32:19' pdfFileUrl: /v1/files/2c98901f62d7d83d0162d7facea6262d - debitMemoId: 2c98908a904dfc2601904e6e14090241 debitMemoNumber: DM00000004 pdfGenerationStatus: Error createdOn: '2024-01-02 10:14:13' updatedOn: '2024-01-02 10:14:13' errorCode: INVALID_TEMPLATE errorMessage: Unknown merge filed chargeNumber__c - debitMemoId: 402824aa8cc894d5018cc8a120576881 debitMemoNumber: DM00000005 pdfGenerationStatus: Pending createdOn: '2024-01-01 11:35:56' updatedOn: '2024-01-01 11:35:56' success: true properties: debitMemoFiles: description: | Array of debit memo PDF statuses requested. items: $ref: '#/components/schemas/GetDebitMemoPdfStatusResponse' type: array success: description: | Indicates whether the call succeeded. type: boolean type: object title: debitMemoFiles GetDebitMemoPdfStatusResponse: allOf: - properties: debitMemoId: description: | The ID of the debit memo whose pdf status is requested. type: string debitMemoNumber: description: | The debit memo number of the debit memo whose pdf status is requested. type: string pdfGenerationStatus: description: | The generation status of the debit memo PDF. type: string enum: - None - Pending - Processing - Generated - Error - Obsolete createdOn: description: | The time at which the request to generate the PDF was created. type: string updatedOn: description: | The time at which the request to generate the PDF was updated. type: string pdfFileURL: description: | The file path or the URL of the PDF when the status is `Generated`. type: string errorCategory: description: | The error category when the status is `Error`. type: string errorMessage: description: | The error message when the status is `Error`. type: string type: object GetDebitMemoApplicationPartCollectionType: properties: applicationParts: description: | Container for application parts. items: $ref: '#/components/schemas/GetDebitMemoApplicationPartType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GetDebitMemoApplicationPartType: properties: appliedAmount: description: | The amount that is applied to the debit memo. format: double type: number createdById: description: | The ID of the Zuora user who created the payment or credit memo. format: uuid type: string createdDate: description: | The date and time when the payment or credit memo was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-12-01 15:31:10. format: date-time type: string creditMemoId: description: | The ID of credit memo that is applied to the specified debit memo. format: uuid type: string paymentId: description: | The ID of the payment that is applied to the specified debit memo. format: uuid type: string updatedById: description: | The ID of the Zuora user who last updated the payment or credit memo. format: uuid type: string updatedDate: description: | The date and time when the payment or credit memo was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2018-01-02 11:42:16. format: date-time type: string title: applicationParts type: object GETTaxationItemsOfDebitMemoItemType: allOf: - properties: data: description: | Container for the taxation items of the debit memo item. items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETDMTaxItemTypeNew: allOf: - properties: balance: description: | The balance of the taxation item. format: double type: number creditAmount: description: | The amount of credit memos applied to the debit memo. format: double type: number exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. type: string salesTaxPayableAccountingCodeType: description: | The type of the accounting code for the sales taxes payable. type: string type: object id: description: | The ID of the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of the taxation item. type: string paymentAmount: description: | The amount of payments applied to the debit memo. format: double type: number sourceTaxItemId: description: | The ID of the source taxation item. type: string taxAmount: description: | The amount of taxation. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date that the tax is applied to the debit memo, in `yyyy-mm-dd` format. format: date type: string taxRate: description: | The tax rate applied to the debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate. enum: - Percentage - FlatFee type: string type: object - $ref: '#/components/schemas/DebitTaxationItemObjectCustomFields' title: data DebitMemoCollectRequest: example: collect: true applyCredit: true properties: applicationOrder: description: | The priority order to apply credit memos and/or unapplied payments to the debit memo. Possible item values are: `CreditMemo`, `UnappliedPayment`. **Note:** - This field is valid only if the `applyCredit` field is set to `true`. - If no value is specified for this field, the default priority order is used, ["CreditMemo", "UnappliedPayment"], to apply credit memos first and then apply unapplied payments. - If only one item is specified, only the items of the spedified type are applied to invoices. For example, if the value is `["CreditMemo"]`, only credit memos are used to apply the debit memo. items: type: string type: array applyCredit: default: false description: | Whether to automatically apply credit memos or unapplied payments, or both to the debit memo. If the value is `true`, the credit memo or unapplied payment, or both will be automatically applied to the debit memo. If no value is specified or the value is `false`, no action is taken. type: boolean collect: default: false description: | Indicates if the current request needs to collect payment or not. type: boolean payment: description: | Some detail info that would be used to processed an electronic payment. The info would only effect when `collect` set to `true`. properties: gatewayId: description: | The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method. If no gateway ID is specified in the request body, the default gateway for the customer account is used automatically, if this default one is not configured, the default gateway of the tenant would be used. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs. type: string type: object type: object DebitMemoCollectResponse: allOf: - properties: appliedCreditMemos: description: | The information about which credit memo applied to the specific debit memo. items: $ref: '#/components/schemas/DebitMemoCollectResponseAppliedCreditMemos' type: array appliedPayments: description: | The information about which payment applied to the specific debit memo. items: $ref: '#/components/schemas/DebitMemoCollectResponseAppliedPayments' type: array debitMemo: description: | The information about the debit memo that just collected. properties: id: description: | The unique ID of the debit memo. type: string number: description: | The unique identification number of the debit memo. type: string type: object organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string processedPayment: description: | The information about the payment that newly processed to the debit memo. properties: amount: description: | The total amount of the payment. format: double type: number gatewayId: description: | The ID of the gateway instance that processes the payment. type: string gatewayResponse: description: | The message returned from the payment gateway for the payment. This message is gateway-dependent. type: string gatewayResponseCode: description: | The code returned from the payment gateway for the payment. This code is gateway-dependent. type: string id: description: | The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f. type: string number: description: | The unique identification number of the payment. For example, P-00000001. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. type: string status: description: | The status of the payment. enum: - Processing - Processed - Error - Canceled type: string type: object success: description: Returns `true` if the request was processed successfully. type: boolean type: object DebitMemoCollectResponseAppliedCreditMemos: allOf: - properties: appliedAmount: description: | The applied amount of the credit memo to the debit memo. format: double type: number id: description: | The unique ID of the credit memo. type: string number: description: | The unique identification number of the credit memo. type: string unappliedAmount: description: | The unapplied amount of the credit memo after applied to the debit memo. format: double type: number type: object DebitMemoCollectResponseAppliedPayments: allOf: - properties: appliedAmount: description: | The applied amount of the payment to the debit memo. format: double type: number id: description: | The unique ID of the payment. type: string number: description: | The unique identification number of the payment. type: string unappliedAmount: description: | The unapplied amount of the payment after applied to the debit memo. format: double type: number type: object PostDebitMemoEmailType: example: useEmailTemplateSetting: true properties: emailAddresses: description: | The valid email addresses you want to email a debit memo to. Use commas to separate email addresses. **Note:** This field is only applicable if you set the `useEmailTemplateSetting` field to `false`. type: string includeAdditionalEmailAddresses: default: false description: | Indicates whether to send a debit memo to the additional email addresses of the memo account. You can set the additional email addresses in the **Additional Email Addresses** field on the account detail page from the Zuora UI. See [Create a Customer Account](https://knowledgecenter.zuora.com/BC_Subscription_Management/Customer_Accounts/B_Create_a_Customer_Account#section_2) for more information. enum: - true - false type: boolean pdfFileId: description: | The ID of the PDF file that you want to send in the email. If you do not specify any PDF file ID, the latest PDF file generated for the debit memo is sent in the email. type: string useEmailTemplateSetting: default: false description: | Indicates whether to email a debit memo based on the email template setting. If you set this field to `true`, the debit memo is sent to the email addresses specified in the **To Email** field of the email template. The email template is the one you set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template. enum: - true - false type: boolean type: object GETDebitMemoFilesResponse: properties: debitMemoFiles: description: | Container for debit memo PDF files. items: $ref: '#/components/schemas/DebitMemoFile' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object DebitMemoFile: properties: id: description: | The ID of the debit memo PDF file. This is the ID for the file object and different from the file handle ID in the `pdfFileUrl` field. To open a file, you have to use the file handle ID. type: string pdfFileUrl: description: | The relative URL of the debit memo PDF file. You can obtain the absolute URL for downloading the file by adding a prefix in the following format: `{environment_base_url}/apps` For example, `https://apisandbox.zuora.com/apps/v1/files/2c98901f62d7d83d0162d7facea6262d`. type: string versionNumber: description: | The version number of the debit memo PDF file. format: int64 type: integer title: debitMemoFile type: object GETDebitMemoItemCollectionType: properties: items: description: | Container for debit memo items. items: $ref: '#/components/schemas/GETDebitMemoItemTypewithSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETDebitMemoItemTypewithSuccess: allOf: - properties: amount: description: | The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax. format: double type: number amountWithoutTax: description: | The debit memo item amount excluding tax. format: double type: number appliedToItemId: description: | The parent debit memo item that this debit memo items is applied to if this item is discount. type: string balance: description: | The balance of the debit memo item. format: double type: number beAppliedAmount: description: | The applied amount of the debit memo item. format: double type: number createdById: description: | The ID of the Zuora user who created the debit memo item. type: string createdDate: description: | The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string description: description: | The description of the debit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the debit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. type: string deferredRevenueAccountingCodeType: description: | The type of the deferred revenue accounting code, such as Deferred Revenue. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. type: string recognizedRevenueAccountingCodeType: description: | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. type: string revenueScheduleNumber: description: | The revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001. type: string type: object id: description: | The ID of the debit memo item. type: string processingType: description: | The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. type: string quantity: description: | The number of units for the debit memo item. format: double type: number reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. serviceEndDate: description: | The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field. format: date type: string serviceStartDate: description: | The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge. format: date type: string sku: description: | The SKU for the product associated with the debit memo item. type: string skuName: description: | The name of the SKU. type: string shipToContactId: description: | The ID of the ship-to contact associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string soldToContactId: description: | The ID of the sold-to contact associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string sourceItemId: description: | The ID of the source item. type: string sourceItemType: description: | The type of the source item. enum: - CreditMemoItem - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge type: string subscriptionId: description: | The ID of the subscription associated with the debit memo item. type: string taxMode: description: | The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax. enum: - TaxExclusive - TaxInclusive type: string taxationItems: description: | Container for the taxation items of the debit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). properties: data: description: | List of taxation items. items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string type: object unitOfMeasure: description: | The units to measure usage. type: string unitPrice: description: | The per-unit price of the debit memo item. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the debit memo item. type: string updatedDate: description: | The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' title: items GETDebitMemoItemType: allOf: - properties: amount: description: | The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax. format: double type: number amountWithoutTax: description: | The debit memo item amount excluding tax. format: double type: number appliedToItemId: description: | The parent debit memo item that this debit memo items is applied to if this item is discount. type: string balance: description: | The balance of the debit memo item. format: double type: number beAppliedAmount: description: | The applied amount of the debit memo item. format: double type: number createdById: description: | The ID of the Zuora user who created the debit memo item. type: string createdDate: description: | The date and time when the debit memo item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string description: description: | Description about the debit memo item. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `257.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the debit memo item from revenue accounting. **Note**: This field is only available if you have the Order to Revenue or Billing - Revenue Integration feature enabled. type: boolean financeInformation: description: | Container for the finance information related to the debit memo item. properties: deferredRevenueAccountingCode: description: | The accounting code for the deferred revenue, such as Monthly Recurring Liability. type: string deferredRevenueAccountingCodeType: description: | The type of the deferred revenue accounting code, such as Deferred Revenue. type: string recognizedRevenueAccountingCode: description: | The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges. type: string recognizedRevenueAccountingCodeType: description: | The type of the recognized revenue accounting code, such as Sales Revenue or Sales Discount. type: string revenueRecognitionRuleName: description: | The name of the revenue recognition rule governing the revenue schedule. type: string revenueScheduleNumber: description: | The revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, RS-00000001. type: string type: object id: description: | The ID of the debit memo item. type: string processingType: description: | The kind of the charge for the debit memo item. Its possible values are `Charge` and `Discount`. type: string quantity: description: | The number of units for the debit memo item. format: double type: number reflectDiscountInNetAmount: type: boolean default: false description: | When you apply percentage discounts to either of the following charges, you need to set the `reflectDiscountInNetAmount` field on your discount charge to `true`, to enable calculating and displaying the net amount of the following charges in Zuora Revenue. * delivery pricing charge * prepayment charge * drawdown charge Note the following: * If you are an Order to Revenue customer, when you set the `reflectDiscountInNetAmount` field to `true`, you must also set the `excludeItemBillingFromRevenueAccounting` field to `true`. * If you are a Billing - Revenue Integration customer, you must set the `reflectDiscountInNetAmount` field to `false`, otherwise an error will be returned. Billing - Revenue Integration does not support discounts on the preceding charges. * If you are a Zuora Billing customer who does not enable the Order to Revenue or Billing - Revenue Integration feature, when you apply percentage discounts to the preceding charges, you also need to set the `reflectDiscountInNetAmount` field to `true`. serviceEndDate: description: | The end date of the service period associated with this debit memo item. Service ends one second before the date specified in this field. format: date type: string serviceStartDate: description: | The start date of the service period associated with this debit memo item. If the associated charge is a one-time fee, this date is the date of that charge. format: date type: string sku: description: | The SKU for the product associated with the debit memo item. type: string skuName: description: | The name of the SKU. type: string shipToContactId: description: | The ID of the ship-to contact associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string soldToContactId: description: | The ID of the sold-to contact associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string soldToContactSnapshotId: description: | The ID of the sold-to contact snapshot associated with the invoice item. The value of this field is `null` if you have the [Flexible Billing Attributes](https://knowledgecenter.zuora.com/Billing/Subscriptions/Flexible_Billing_Attributes) feature disabled. type: string sourceItemId: description: | The ID of the source item. type: string sourceItemType: description: | The type of the source item. enum: - CreditMemoItem - SubscriptionComponent - InvoiceDetail - ProductRatePlanCharge type: string subscriptionId: description: | The ID of the subscription associated with the debit memo item. type: string success: description: Returns `true` if the request was processed successfully. type: boolean taxMode: description: | The tax mode of the debit memo item, indicating whether the amount of the debit memo item includes tax. enum: - TaxExclusive - TaxInclusive type: string taxationItems: description: | Container for the taxation items of the debit memo item. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). properties: data: description: | List of taxation items. items: $ref: '#/components/schemas/GETDMTaxItemTypeNew' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string type: object unitOfMeasure: description: | The units to measure usage. type: string unitPrice: description: | The per-unit price of the debit memo item. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the debit memo item. type: string updatedDate: description: | The date and time when the debit memo item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/DebitMemoItemObjectCustomFields' POSTTaxationItemListForDMType: example: taxationItems: - name: STATE TAX memoItemId: 8ad093f793300daf01933d50a548781f jurisdiction: CALIFORNIA taxAmount: 0.5 taxCode: ServiceTaxCode taxDate: '2024-11-18' taxRate: 0.05 taxRateType: Percentage properties: taxationItems: description: | Container for taxation items. items: $ref: '#/components/schemas/POSTTaxationItemForDMType' type: array type: object POSTTaxationItemForDMType: allOf: - properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string memoItemId: description: | The ID of the debit memo that the taxation item is created for. type: string name: description: | The name of the taxation item. type: string sourceTaxItemId: description: | The ID of the taxation item of the invoice, which the debit memo is created from. If you want to use this REST API to create taxation items for a debit memo created from an invoice, the taxation items of the invoice must be created or imported through the SOAP API call. **Note:** - This field is only used if the debit memo is created from an invoice. - If you do not contain this field in the request body, Zuora will automatically set a value for the `sourceTaxItemId` field based on the tax location code, tax jurisdiction, and tax rate. type: string taxAmount: description: | The amount of the tax applied to the debit memo. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date when the tax is applied to the debit memo. format: date type: string taxRate: description: | The tax rate applied to the debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the debit memo. enum: - Percentage - FlatFee type: string required: - taxRate - jurisdiction - name - taxRateType - taxAmount type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' title: taxationItems PUTWriteOffDebitMemoRequest: allOf: - properties: comment: description: | Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice. maxLength: 255 minLength: 0 type: string amount: description: | The write off amount of the invoice. type: number taxAutoCalculation: description: | Indicates whether to automatically calculate taxes in the credit memo. type: boolean revenueImpacting: description: | Indicates whether this write off operation impacts the revenue. If `revenueImpacting` = `Yes`, the deferred revenue accounting code will be automatically selected from the associated invoice. The **Exclude Billing Item From Revenue** field will be automatically set to **Yes** by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing. If `revenueImpacting` = `No`, users can select an accounting code such as bad-debt expense accounting code for the write off operation. enum: - 'Yes' - 'No' default: 'Yes' type: string nonRevenueWriteOffAccountingCode: description: | Specify the accounting code for the non revenue write off. Available only if `revenueImpacting` = `no`. **Note**: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact Zuora Global Support to enable this permission. type: string items: description: | Container for items. This field is optional. **Note:** If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice. items: $ref: '#/components/schemas/DebitMemoItemFromWriteOffInvoice' type: array memoDate: description: | The date when the credit memo was created, in `yyyy-mm-dd` format. The memo date must be later than or equal to the invoice date. The default value is the date when you write off the invoice. format: date type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code `Write-off`. type: string type: object - $ref: '#/components/schemas/CreditMemoObjectCustomFields' - $ref: '#/components/schemas/CreditMemoObjectNSFields' example: memoDate: '2019-01-02' type: object PUTWriteOffDebitMemoResponse: properties: creditMemo: description: | Container for the credit memo that is automatically generated when writing off invoices. properties: id: description: | The ID of the credit memo that is created when the invoice is written off. type: string type: object success: description: | Returns `true` if the request was processed successfully. type: boolean type: object DebitMemoItemFromWriteOffInvoice: allOf: - properties: comment: description: | Comments about the credit memo item. type: string amountWithoutTax: description: | The credit memo item amount excluding tax. format: double type: number debitMemoItemId: description: | The ID of the debit memo item. type: string serviceEndDate: description: | The service end date of the credit memo item. format: date type: string serviceStartDate: description: | The service start date of the credit memo item. format: date type: string skuName: description: | The name of the charge associated with the invoice. type: string unitOfMeasure: description: | The definable unit that you measure when determining charges. type: string excludeItemBillingFromRevenueAccounting: description: | The flag to exclude the credit memo item from revenue accounting. **Note**: This field is only available if you have the Billing - Revenue Integration feature enabled. type: boolean taxationItems: description: | Container for the taxation items of the credit memo item. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `239.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). items: properties: amount: description: | The credit memo taxation amount. type: number taxationItemId: description: | The Id of the debit memo item. type: string type: object type: array type: object - $ref: '#/components/schemas/CreditMemoItemObjectCustomFields' title: items ListEInvoicingServiceProvidersResponse: properties: serviceProviders: description: | Container for e-invoicing service providers. items: $ref: '#/components/schemas/GetEInvoicingServiceProviderResponse' type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GetEInvoicingServiceProviderResponse: allOf: - properties: companyIdentifier: description: | The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent. type: string id: description: | The ID of the e-invoicing service provider. type: string name: description: | The name of the e-invoicing service provider. maxLength: 100 type: string provider: description: | The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents. enum: - Sovos - PEPPOL - Avalara type: string serviceProviderNumber: description: | The unique number of the e-invoicing service provider. type: string test: description: | Whether the e-invoicing service provider's configuration is intended for testing. - If you set this field to `true`, requests are directed to the testing integration endpoints. - If you set this field to `false`, requests are directed to the production integration endpoints. type: boolean apiKey: description: | The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. type: string clientCertificate: description: | The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider. type: string format: byte clientCertificateType: description: | The client certificate type is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos service provider. type: string default: PKCS12 title: serviceProviders type: object CreateEInvoicingServiceProviderRequest: allOf: - properties: companyIdentifier: description: | The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent. type: string name: description: | The name of the e-invoicing service provider. maxLength: 100 type: string provider: description: | The name of the e-invoicing service provider that can help you generate e-invoice files for billing documents. enum: - Sovos - PEPPOL - Avalara type: string test: description: | Whether the e-invoicing service provider's configuration is intended for testing. - If you set this field to `true`, requests are directed to the testing integration endpoints. - If you set this field to `false`, requests are directed to the production integration endpoints. type: boolean apiKey: description: | The API key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos or Avalara as the service provider. type: string secretKey: description: | The secret key is used to authenticate the e-invoicing service provider's requests. This field is required for configuring Sovos or Avalara as the service provider. type: string clientCertificate: description: | The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field is required for configuring Sovos as the service provider. type: string format: byte clientCertificateType: description: | The client certificate type is used to specify the type of the client certificate. This field is required for configuring Sovos as the service provider. type: string default: PKCS12 clientCertificatePassword: description: | The client certificate password is the password to protect the client certificate. This field is required for configuring Sovos as the service provider. type: string format: password required: - name - provider type: object example: name: Sovos e-invoice service provider: Sovos test: false companyIdentifier: CompanySample1 apiKey: ApiKeySample secretKey: SecretKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 clientCertificatePassword: ClientCertificatePassword UpdateEInvoicingServiceProviderRequest: allOf: - properties: companyIdentifier: description: | The identifier of the company used to create a sender system ID, which serves to identify the system where the transactions are sent. type: string name: description: | The name of the e-invoicing service provider. maxLength: 100 type: string test: description: | Whether the e-invoicing service provider's configuration is intended for testing. - If you set this field to `true`, requests are directed to the testing integration endpoints. - If you set this field to `false`, requests are directed to the production integration endpoints. type: boolean apiKey: description: | The API key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. type: string secretKey: description: | The secret key is used to authenticate the e-invoicing service provider's requests. This field only applies to the Sovos or Avalara service provider. type: string clientCertificate: description: | The client certificate is used to authenticate the e-invoicing service provider's requests, which should be in base64 encoded format. This field only applies to the Sovos service provider. type: string format: byte clientCertificateType: description: | The client certificate type is used to specify the type of the client certificate. This field only applies to the Sovos service provider. type: string default: PKCS12 clientCertificatePassword: description: | The client certificate password is the password to protect the client certificate. This field only applies to the Sovos service provider. type: string format: password type: object example: name: Sovos e-invoice service test: false companyIdentifier: CompanySample1 apiKey: ApiKeySample secretKey: SecretKey clientCertificate: U3dhZ2dlciByb2Nrcw== clientCertificateType: PKCS12 clientCertificatePassword: ClientCertificatePassword ListEInvoicingBusinessRegionsResponse: properties: regions: description: | Container for e-invoicing business regions. items: $ref: '#/components/schemas/GetEInvoicingBusinessRegionResponse' type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GetEInvoicingBusinessRegionResponse: allOf: - properties: id: description: | The unique ID of the e-invoicing business region. type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: string businessName: description: | The full official name that the Seller is registered with the relevant legal authority. maxLength: 255 type: string businessNumber: description: | The specify the unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia. type: string businessNumberSchemaId: description: | The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person. type: string tradeName: description: | The name that the Seller is known as, other than the legal business name. maxLength: 100 type: string nullable: true endpointId: description: | The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered. type: string endpointSchemeId: description: | The identification scheme identifier of the Seller’s electronic address. type: string taxRegisterNumber: description: | The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status. type: string nullable: true state: description: | The name of the state or province where the business is located. type: string nullable: true city: description: | The the name of the city where the business is located. type: string postalCode: description: | The short code that can identify the business address. type: string addressLine1: description: | The first line of the Seller’s address, which is often a street address or business name. type: string nullable: true addressLine2: description: | The second line of the Seller’s address, which is often the name of a building. type: string nullable: true contactName: description: | The name of the Seller contact to receive e-invoicing data. maxLength: 255 type: string nullable: true phoneNumber: description: | The business phone number of the Seller contact to receive e-invoicing data. type: string nullable: true email: description: | The email address of the Seller contact to receive e-invoicing data. type: string nullable: true serviceProviderId: description: | The unique ID of the e-invoicing service provider that is associated to the business region. type: string businessRegionNumber: description: | The unique number of the e-invoicing business region. type: string digitalSignatureEnable: description: | Whether the e-invoicing service provider signs PDF files for billing documents. default: false type: boolean digitalSignatureBoxEnable: description: | Whether the digital signature box is displayed on PDF files for billing documents. default: false type: boolean digitalSignatureBoxPosX: description: | The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 digitalSignatureBoxPosY: description: | The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 responseMapping: description: | Container for e-invoicing response field mappings that map values from the e-invoicing service provider’s response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path. **Note**: This field is applicable only to the Sovos or Avalara service provider. For more information, see Configure e-invoicing response field mappings. type: object title: responseMapping additionalProperties: type: string description: | The response field mapping consists of a key-value pair: * Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field, which applies only to Sovos).
Zuora supports the following field names. For more information, see Supported response fields. * `AuthorizationCode` * `EInvoiceFile` * `QrCode` * `ReferenceNumber` * `Field1` to `Field10` * Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the XPath syntax. For more information, see Field path format. processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. type: string enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown invoiceEnabled: description: | It will control whether the invoice should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara. type: boolean default: false creditMemoEnabled: description: | It will control whether the credit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara. type: boolean default: false debitMemoEnabled: description: | It will control whether the debit memo should be supported by the process type or not. This field is available when the service provider is Sovos or Avalara. type: boolean default: false invoiceFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/InvoiceFiltersResponseType' type: array creditMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/CreditMemoFiltersResponseType' type: array debitMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/DebitMemoFiltersResponseType' type: array fileFormat: description: | The file format for each business category. An example response is "[ "application/xml", "application/vnd.oasis.ubl+xml" ]" type: array items: type: string success: description: | Indicats if the request succeeds. type: boolean title: regions type: object InvoiceFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/InvoiceFiltersCondition' type: object title: InvoiceFilters CreditMemoFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/CreditMemoFiltersCondition' type: object title: CreditMemoFilters DebitMemoFiltersResponseType: allOf: - properties: condition: $ref: '#/components/schemas/DebitMemoFiltersCondition' type: object title: DebitMemoFilters DebitMemoFiltersCondition: allOf: - description: Container for condition information about the debit memo filters. properties: conditions: description: | Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields. type: array items: $ref: '#/components/schemas/DebitMemoFiltersCondition' field: description: | The field name of a single condition that is indicated by the `conditions` field. type: string operator: description: | The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null) type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: description: | The relation among the `conditions` fields. type: string enum: - and - or value: description: | The value of a single condition that is indicated by the `conditions` field. type: string objectType: description: | The target object type of the condition when the `filterType` field is specified as `FilterCondition`. type: string enum: - DebitMemo - DebitMemoItem type: object title: Condition CreditMemoFiltersCondition: allOf: - description: Container for condition information about the credit memo filters. properties: conditions: description: | Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields. type: array items: $ref: '#/components/schemas/CreditMemoFiltersCondition' field: description: | The field name of a single condition that is indicated by the `conditions` field. type: string operator: description: | The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null) type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: description: | The relation among the `conditions` fields. type: string enum: - and - or value: description: | The value of a single condition that is indicated by the `conditions` field. type: string objectType: description: | The target object type of the condition when the `filterType` field is specified as `FilterCondition`. type: string enum: - CreditMemo - CreditMemoItem type: object title: Condition InvoiceFiltersCondition: allOf: - description: Container for condition information about the invoice filters. properties: conditions: description: | Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields. type: array items: $ref: '#/components/schemas/InvoiceFiltersCondition' field: description: | The field name of a single condition that is indicated by the `conditions` field. type: string operator: description: | The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null) type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: description: | The relation among the `conditions` fields. type: string enum: - and - or value: description: | The value of a single condition that is indicated by the `conditions` field. type: string objectType: description: | The target object type of the condition when the `filterType` field is specified as `FilterCondition`. type: string enum: - Invoice - InvoiceItem type: object title: Condition CreateEInvoicingBusinessRegionRequest: allOf: - properties: addressLine1: description: | The first line of the Seller's address, which is often a street address or business name. type: string addressLine2: description: | The second line of the Seller's address, which is often the name of a building. type: string businessName: description: | The full official name that the Seller is registered with the relevant legal authority. maxLength: 255 type: string businessNumber: description: | The specify the unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia. type: string businessNumberSchemaId: description: | The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person. type: string city: description: | The the name of the city where the business is located. type: string contactName: description: | The name of the Seller contact to receive e-invoicing data. maxLength: 255 type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: string digitalSignatureEnable: description: | Whether the e-invoicing service provider signs PDF files for billing documents. default: false type: boolean digitalSignatureBoxEnable: description: | Whether the digital signature box is displayed on PDF files for billing documents. default: false type: boolean digitalSignatureBoxPosX: description: | The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 digitalSignatureBoxPosY: description: | The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 email: description: | The email address of the Seller contact to receive e-invoicing data. type: string endpointId: description: | The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered. type: string endpointSchemeId: description: | The identification scheme identifier of the Seller's electronic address. type: string phoneNumber: description: | The business phone number of the Seller contact to receive e-invoicing data. type: string postalCode: description: | The short code that can identify the business address. type: string responseMapping: description: | Container for e-invoicing response field mappings that map values from the e-invoicing service provider's response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path. **Note**: This field is applicable only to the Sovos or Avalara service provider. For more information, see Configure e-invoicing response field mappings. type: object title: responseMapping additionalProperties: type: string description: | The response field mapping consists of a key-value pair: * Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field, which applies only to Sovos).
Zuora supports the following field names. For more information, see Supported response fields. * `AuthorizationCode` * `EInvoiceFile` * `QrCode` * `ReferenceNumber` * `Field1` to `Field10` * Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the XPath syntax. For more information, see Field path format. processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, specify the process type as `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, specify the process type as `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, leave this field empty. type: string enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork invoiceEnabled: description: | This field controls whether the invoice should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false creditMemoEnabled: description: | This field controls whether the credit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false debitMemoEnabled: description: | This field controls whether the debit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false invoiceFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/InvoiceFiltersRequestType' type: array creditMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/CreditMemoFiltersRequestType' type: array debitMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/DebitMemoFiltersRequestType' type: array serviceProviderId: description: | The unique ID of the e-invoicing service provider that is associated to the business region. type: string state: description: | The name of the state or province where the business is located. type: string taxRegisterNumber: description: | The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller's address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status. type: string tradeName: description: | The name that the Seller is known as, other than the legal business name. maxLength: 100 type: string fileFormat: description: | You can define the file format for each business category as shown in the following example: fileFormat" : { "B2B" : [ "XML" ], "B2C" : [ ], "B2G" : [ "XML" ] } **Note:** This field is optional; however, if you use Avalara integration, it becomes a mandatory field. type: array items: type: string required: - country - businessName type: object example: addressLine1: null addressLine2: null businessName: legal business name businessNumber: '20002039' businessNumberSchemaId: '88' city: Tokyo contactName: null country: JP email: null endpointId: '8992' endpointSchemeId: '88' invoiceFilters: - objectType: Invoice condition: field: SoldToContact.Country operator: eq value: India phoneNumber: null postalCode: '368779' serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: null taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML InvoiceFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/InvoiceFiltersCondition' required: - filterType type: object title: InvoiceFilters CreditMemoFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/CreditMemoFiltersCondition' required: - filterType type: object title: CreditMemoFilters DebitMemoFiltersRequestType: allOf: - properties: condition: $ref: '#/components/schemas/DebitMemoFiltersCondition' required: - filterType type: object title: DebitMemoFilters UpdateEInvoicingBusinessRegionRequest: allOf: - properties: addressLine1: description: | The first line of the Seller's address, which is often a street address or business name. type: string addressLine2: description: | The second line of the Seller's address, which is often the name of a building. type: string businessName: description: | The full official name that the Seller is registered with the relevant legal authority. maxLength: 255 type: string businessNumber: description: | The specify the unique identifier number of the legal entity or person that you do business with. For example, you must use a GSTIN for India and Tax Identification Number (TIN) for Saudi Arabia. type: string businessNumberSchemaId: description: | The identification scheme identifier that an official registrar issues to identify the Seller as a legal entity or person. type: string city: description: | The the name of the city where the business is located. type: string contactName: description: | The name of the Seller contact to receive e-invoicing data. maxLength: 255 type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: string digitalSignatureEnable: description: | Whether the e-invoicing service provider signs PDF files for billing documents. default: false type: boolean digitalSignatureBoxEnable: description: | Whether the digital signature box is displayed on PDF files for billing documents. default: false type: boolean digitalSignatureBoxPosX: description: | The X-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 digitalSignatureBoxPosY: description: | The Y-coordinate to determine where the digital signature box is displayed on PDF files for billing documents. type: number minimum: 0 email: description: | The email address of the Seller contact to receive e-invoicing data. type: string endpointId: description: | The Seller's electronic address, to which the application-level response to the e-invoice file might be delivered. type: string endpointSchemeId: description: | The identification scheme identifier of the Seller's electronic address. type: string phoneNumber: description: | The business phone number of the Seller contact to receive e-invoicing data. type: string postalCode: description: | The short code that can identify the business address. type: string responseMapping: description: | Container for e-invoicing response field mappings that map values from Sovos response data to fields on the EInvoiceData object in Zuora. Each response field mapping consists of a field name and a field path. Note that this field is applicable only to the Sovos service provider. For more information, see Configure e-invoicing response field mappings. type: object title: responseMapping additionalProperties: type: string description: | The response field mapping consists of a key-value pair: * Field name: the name of the field on the EInvoiceData object (except for the `EInvoiceFile` field).
Zuora supports the following field names. For more information, see Supported response fields. * `AuthorizationCode` * `EInvoiceFile` * `QrCode` * `ReferenceNumber` * `Field1` to `Field10` * Field value: the path of an XML node in the e-invoicing response data from Sovos. The value of this field must be compliant with the XPath syntax. For more information, see Field path format. invoiceEnabled: description: | This field controls whether the invoice should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false creditMemoEnabled: description: | This field controls whether the credit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false debitMemoEnabled: description: | This field controls whether the debit memo should be supported by the process type or not. For some countries, this field is required to be set to `true`. For more information, see Manage country-specific configurations. type: boolean default: false invoiceFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/InvoiceFiltersRequestType' type: array creditMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/CreditMemoFiltersRequestType' type: array debitMemoFilters: description: | The documents belonging to the e-invoicing business region. items: $ref: '#/components/schemas/DebitMemoFiltersRequestType' type: array serviceProviderId: description: | The unique ID of the e-invoicing service provider that is associated to the business region. type: string state: description: | The name of the state or province where the business is located. type: string taxRegisterNumber: description: | The Seller's VAT identifier (also known as Seller VAT identification number) or the local identification (defined by the Seller’s address) of the Seller for tax purposes, or a reference that enables the Seller to state the registered tax status. type: string tradeName: description: | The name that the Seller is known as, other than the legal business name. maxLength: 100 type: string fileFormat: description: | You can define the file format for each business category as shwown in the following example: fileFormat" : { "B2B" : [ "XML" ], "B2C" : [ ], "B2G" : [ "XML" ] } **Note:** This field is optional; however, if you use Avalara integration, it becomes a mandatory field. type: array items: type: string type: object example: addressLine1: null addressLine2: null businessName: legal business name businessNumber": '20002039' businessNumberSchemaId: '88' city: Tokyo contactName: null country: JP email: null endpointId: '8992' endpointSchemeId: '88' phoneNumber: null postalCode: '368779' serviceProviderId: 4028948972a2bf990172bc9b27724ddc state: null taxRegisterNumber: TAX393999 tradeName: Zuora fileFormat: B2B: - XML B2C: - '' B2G: - XML EinvoiceFetchMandates: properties: data: description: | Container for fetching mandates. items: $ref: '#/components/schemas/GETEinvoiceFetchMandates' type: array error: description: | Container for fetching validation errors. items: $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrors' type: array type: object GETEinvoiceFetchMandates: allOf: - properties: countryCode: description: | 2-digit country code. type: string nullable: false fileFormats: description: | Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` type: array items: type: string nullable: false category: description: | The business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G. type: string enum: - B2B - B2C - B2G processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: description: | The default file format. type: string GETEinvoiceFetchMandatesErrors: allOf: - properties: success: description: | Returns `false` if the request was not processed successfully. type: boolean processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceFetchMandatesErrorsReasons' requestId: description: | Request Id for the validation error. type: string GETEinvoiceFetchMandatesErrorsReasons: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string EinvoiceInvoiceFetchMandate: properties: success: description: | Container for fetching mandates. items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandate' type: array error: description: | Container for fetching validation errors. items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandatesError' type: array type: object GETEinvoiceInvoiceFetchMandate: allOf: - properties: countryCode: description: | 2-digit country code. type: string nullable: false fileFormats: description: | Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` type: array items: type: string nullable: false category: description: | The business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G. type: string enum: - B2B - B2C - B2G processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: description: | The default file format. type: string GETEinvoiceInvoiceFetchMandatesError: allOf: - properties: success: description: | Returns `false` if the request was not processed successfully. type: boolean processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceInvoiceFetchMandatesErrorsReasons' requestId: description: | Request Id for the validation error. type: string GETEinvoiceInvoiceFetchMandatesErrorsReasons: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string CreditMemosEinvoiceMandate: properties: success: description: | Container for fetching mandates. items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandate' type: array error: description: | Container for fetching validation errors. items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandatesErrors' type: array type: object GETEinvoiceCreditMemosMandate: allOf: - properties: countryCode: description: | 2-digit country code. type: string nullable: false fileFormats: description: | Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` type: array items: type: string nullable: false category: description: | Business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G. type: string enum: - B2B - B2C - B2G processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: description: | The default file format. type: string GETEinvoiceCreditMemosMandatesErrors: allOf: - properties: success: description: | Returns `false` if the request was not processed successfully. type: boolean processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceCreditMemosMandatesErrorsReasons' requestId: description: | Request Id for the validation error. type: string GETEinvoiceCreditMemosMandatesErrorsReasons: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string DebitMemosEinvoiceMandate: properties: success: description: | Container for fetching mandates. items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandates' type: array errors: description: | Container for fetching validation errors. items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandatesErrors' type: array type: object GETEinvoiceDebitMemosMandates: allOf: - properties: countryCode: description: | 2-digit country code. type: string nullable: false fileFormats: description: | Following mapping will be used for user representation of file formats: - XML: `application/xml` - PDF: `application/pdf` - ZIP: `application/zip` - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` type: array items: type: string nullable: false category: description: | Business categories that Zuora supports for customer accounts. Supported values are B2B, B2C, or B2G. type: string enum: - B2B - B2C - B2G processType: description: | The process type of the e-invoicing business region. - If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`. - If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`. - If the service provider is PEPPOL, the process type is `Unknown`. enum: - Clearance - ClearanceWithCancellation - PEPPOLNetwork - Unknown type: string defaultFileFormats: description: | The default file format. type: string GETEinvoiceDebitMemosMandatesErrors: allOf: - properties: success: description: | Returns `false` if the request was not processed successfully. type: boolean processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceDebitMemosMandatesErrorsReasons' requestId: description: | Request Id for the validation error. type: string GETEinvoiceDebitMemosMandatesErrorsReasons: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string EinvoiceDownload: properties: success: description: | Stream the file contents. error: description: | Container for downloading e-invoice. items: $ref: '#/components/schemas/GETEinvoiceDownload' type: array type: object GETEinvoiceDownload: allOf: - properties: success: description: | Returns `false` if the request was not processed successfully. type: boolean processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceDownloadErrors' requestId: description: | Request Id for the validation error. type: string GETEinvoiceDownloadErrors: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string CreditMemosEinvoiceDownload: properties: success: description: | Stream the file contents. error: description: | Container for downloading Credit Memo. items: $ref: '#/components/schemas/GETCreditMemosEinvoiceDownload' type: array type: object GETCreditMemosEinvoiceDownload: allOf: - properties: processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETCreditMemosEinvoiceDownloadErrors' requestId: description: | Request Id for the validation error. type: string GETCreditMemosEinvoiceDownloadErrors: allOf: - properties: code: description: | Code for the validation error. type: string message: description: | Validation error message. type: string DebitMemosEinvoiceDownload: properties: success: description: | Stream the file contents. error: description: | Container for downloading Debit Memo. items: $ref: '#/components/schemas/GETDebitMemosEinvoiceDownload' type: array type: object GETDebitMemosEinvoiceDownload: allOf: - properties: processId: description: | Process Id of the validation error. type: string reasons: description: | Container for error reasons. items: $ref: '#/components/schemas/GETEinvoiceDownloadErrors' requestId: description: | Request Id for the validation error. type: string ListEInvoiceFileTemplatesResponse: properties: success: description: | Returns `true` if the request was processed successfully. type: boolean templates: description: | Container for e-invoice file emplates. items: $ref: '#/components/schemas/GetEInvoiceFileTemplateResponse' type: array type: object GetEInvoiceFileTemplateResponse: allOf: - properties: content: description: | The content of the e-invoice file template, which must be encoded in Base64 format. type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: boolean documentType: description: | The type of billing document for which the e-invoice file template is intended. enum: - Invoice - CreditMemo - DebitMemo type: string id: description: | The unique ID of the e-invoice file template. type: string name: description: | The name of the e-invoice file template. maxLength: 255 type: string provider: description: | The name of the e-invoicing service provider that assists in generating e-invoice files for billing documents. enum: - Sovos type: string templateNumber: description: | The unique number of the e-invoice file template. type: string title: templates type: object CreateEInvoiceFileTemplateRequest: allOf: - properties: content: description: | The content of the e-invoice file template, which must be encoded in Base64 format. type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: string documentType: description: | The type of billing documents, which the e-invoice file template is intended for. enum: - Invoice - CreditMemo - DebitMemo type: string name: description: | The name of the e-invoice file template. maxLength: 255 type: string provider: description: | The name of an e-invoicing service provider that assists in generating e-invoice files. enum: - Sovos type: string required: - country - documentType - provider - content - name type: object example: content: base64 encoded content country: IN documentType: Invoice name: Sovos e-invoice service provider: Sovos UpdateEInvoiceFileTemplateRequest: allOf: - properties: content: description: | The content of the e-invoice file template, which must be encoded in Base64 format. type: string country: description: | The short name of a country or region where you must comply with e-invoicing requirements. For example, `IN` for India. For the full list of country names and codes, see View countries or regions. type: string documentType: description: | The type of billing documents, which the e-invoice file template is intended for. enum: - Invoice - CreditMemo - DebitMemo type: string name: description: | The name of the e-invoice file template. maxLength: 255 type: string provider: description: | The name of an e-invoicing service provider that assists in generating e-invoice files. enum: - Sovos type: string type: object example: content: base64 encoded content country: IN documentType: Invoice name: Sovos e-invoice service provider: Sovos POSTCreateInvoiceScheduleRequest: allOf: - properties: accountKey: description: | The ID or number of the account associated with the invoice schedule. type: string additionalSubscriptionsToBill: description: | A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions. items: type: string type: array invoiceSeparately: description: | Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices. type: boolean notes: description: | Comments on the invoice schedule. maxLength: 255 type: string orders: description: | A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders. items: type: string type: array scheduleItems: description: | Container for invoice schedule items. One invoice schedule can have at most 50 invoice schedule items. items: $ref: '#/components/schemas/POSTScheduleItemType' type: array specificSubscriptions: description: | A list of the numbers of specific subscriptions associated with the invoice schedule. - If the subscriptions specified in this field belong to the orders specified in the `orders` field, only the specific subscriptions instead of the orders are associated with the invoice schedule. - If only the `orders` field is specified, all the subscriptions from the order are associated with the invoice schedule. Example: ``` { "orders": [ "O-00000001", "O-00000002" ], "specificSubscriptions": [ { "orderKey": "O-00000001", "subscriptionKey": "S-00000001" } ] } ``` - For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule. - For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule. items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} example: accountKey: A00000007 additionalSubscriptionsToBill: - S-00000001 - S-00000002 invoiceSeparately: false notes: 2022 Billing Schedule orders: - O-00000007 - O-00000008 scheduleItems: - amount: 50000 runDate: '2022-02-24' targetDateForAdditionalSubscriptions: '2022-02-24' - amount: 14000 runDate: '2022-10-17' targetDateForAdditionalSubscriptions: '2022-10-17' - amount: 6200 runDate: '2022-11-14' targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 InvoiceScheduleResponses: allOf: - properties: accountId: description: | The ID of the customer account that the invoice schedule belongs to. type: string actualAmount: description: | The actual amount that needs to be billed during the processing of the invoice schedule. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `totalAmount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed. type: number additionalSubscriptionsToBill: description: | A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions. items: type: string type: array billedAmount: description: | The amount that has been billed during the processing of the invoice schedule. type: number currency: description: | The currency of the billing documents generated during the processing of the invoice schedule. **Note**: - This field is available only if you have the Multiple Currencies feature enabled. - If you have the Multiple Currencies feature disabled, the corresponding account's default currency is always used. type: string id: description: | The unique ID of the invoice schedule. type: string invoiceSeparately: description: | Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices. type: boolean nextRunDate: description: | The run date of the next execution of invoice schedule. By default, the next run date is the same as run date of next pending invoice schedule item. It can be overwritten with a different date other than the default value. When the invoice schedule has completed the execution, the next run date is null. format: date type: string notes: description: | Comments on the invoice schedule. maxLength: 255 type: string number: description: | The sequence number of the invoice schedule. type: string orders: description: | A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders. items: type: string type: array scheduleItems: description: | Container for schedule items. One invoice schedule can have at most 50 invoice schedule items. items: $ref: '#/components/schemas/ScheduleItemsResponse' type: array specificSubscriptions: description: | A list of the numbers of specific subscriptions associated with the invoice schedule. items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array status: description: | The status of the invoice schedule. enum: - Pending - PartiallyProcessed - Paused - FullyProcessed type: string totalAmount: description: | The total amount that needs to be billed during the processing of the invoice schedule. The value of this field keeps unchanged once invoice schedule items are created. type: number unbilledAmount: description: | The amount that is waiting to be billed during the processing of the invoice schedule. type: number type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} ScheduleItemsResponse: allOf: - properties: actualAmount: description: | The actual amount that needs to be billed during the processing of the invoice schedule item. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `amount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed. format: number type: string amount: description: | The amount of the invoice generated during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. The value of this field keeps unchanged once invoice schedule items are created. format: number type: string creditMemoId: description: | The ID of the credit memo that is generated during the processing of the invoice schedule item. type: string id: description: | The unique ID of the invoice schedule item. type: string invoiceId: description: | The ID of the invoice that is generated during the processing of the invoice schedule item. type: string name: description: | The name of the invoice schedule item. maxLength: 100 type: string percentage: description: | The percentage of the total amount to be billed during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. runDate: description: | The date in the tenant’s time zone when the invoice schedule item is processed to generate an invoice. format: date type: string status: description: | The status of the invoice schedule item. enum: - Pending - Executing - Processed type: string targetDateForAdditionalSubscriptions: description: | The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field. format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems InvoiceScheduleSpecificSubscriptions: properties: chargeNumbers: description: | A list of charges in the subscription that are chosen to be included in the invoice schedule. type: string orderKey: description: | The unique ID or number of the order associated with the invoice schedule. type: string subscriptionKey: description: | The unique number of the subscription contained in the order associated with the invoice schedule. type: string title: specificSubscriptions type: object InvoiceScheduleCustomFields: additionalProperties: description: | Custom fields of the Invoice Schedule object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Invoice Schedule object. title: invoiceScheduleCustomFields type: object InvoiceScheduleItemCustomFields: additionalProperties: description: | Custom fields of the Invoice Schedule Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Invoice Schedule Item object. title: invoiceScheduleItemCustomFields type: object POSTScheduleItemType: allOf: - properties: amount: description: | The amount of the invoice to be generated during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. type: number name: description: | The name of the invoice schedule item. maxLength: 100 type: string percentage: description: | The percentage of the total amount to be billed during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. type: number maximum: 100 runDate: description: | The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice. When specifying run dates for invoice schedule items, consider that: - An invoice schedule item with a blank run date will not be executed. - You can only update the run date for an invoice schedule item in Pending status. - If the run date of an invoice schedule item is left empty, the dates of all subsequent invoice schedule items must also be blank. - You must specify run dates in chronological order for invoice schedule items. format: date type: string targetDateForAdditionalSubscriptions: description: | The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field. format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems PUTUpdateInvoiceScheduleRequest: allOf: - properties: additionalSubscriptionsToBill: description: | A list of the numbers of the subscriptions that need to be billed together with the invoice schedule. One invoice schedule can have at most 600 additional subscriptions. items: type: string type: array invoiceSeparately: description: | Whether the invoice items created from the invoice schedule appears on a separate invoice when Zuora generates invoices. type: boolean nextRunDate: description: | The run date of the next execution of the invoice schedule. By default, the next run date is the same as the run date of next pending invoice schedule item. The date can be overwritten by a different date other than the default value. If the invoice schedule has completed the execution, the next run date is `null`. format: date type: string notes: description: | Comments on the invoice schedule. maxLength: 255 type: string orders: description: | A list of the IDs or numbers of the orders associated with the invoice schedule. One invoice schedule can be associated with at most 10 orders. The orders specified in this field override all the existing orders associated with the invoice schedule. items: type: string type: array scheduleItems: description: | Container for invoice schedule items. The maximum number of schedule items is 50. The invoice schedule items specified in this field override all the existing invoice schedule items. items: $ref: '#/components/schemas/UpdateScheduleItems' type: array specificSubscriptions: description: | A list of the numbers of specific subscriptions associated with the invoice schedule. - If the subscriptions specified in this field belong to the orders specified in the `orders` field, only the specific subscriptions instead of the orders are associated with the invoice schedule. - If only the `orders` field is specified, all the subscriptions from the order are associated with the invoice schedule. The specific subscriptions specified in this field override all the existing specific subscriptions associated with the invoice schedule. Example: ``` { "orders": [ "O-00000001", "O-00000002" ], "specificSubscriptions": [ { "orderKey": "O-00000001", "subscriptionKey": "S-00000001" } ] } ``` - For the order with number O-00000001, only subscription S-00000001 contained in the order is associated with the invoice schedule. - For the order with number O-00000002, all subscriptions contained in the order are associated with the invoice schedule. items: $ref: '#/components/schemas/InvoiceScheduleSpecificSubscriptions' type: array type: object - $ref: '#/components/schemas/InvoiceScheduleCustomFields' - {} example: additionalSubscriptionsToBill: - S-00000001 - S-00000002 invoiceSeparately: false nextRunDate: '2022-02-01' notes: 2022 Billing Schedule - V2 orders: - O-00000007 - O-00000008 scheduleItems: - amount: 54000 id: 8a8881aa82118bec018211daf9f01680 runDate: '2022-02-24' targetDateForAdditionalSubscriptions: '2022-02-24' - amount: 10000 id: 8a8881aa82118bec018211daf9f11681 runDate: '2022-10-17' targetDateForAdditionalSubscriptions: '2022-10-17' - amount: 6200 id: 8a8881aa82118bec018211daf9f11682 runDate: '2022-11-14' targetDateForAdditionalSubscriptions: '2022-11-14' specificSubscriptions: - orderKey: O-00000008 subscriptionKey: S-00000008 UpdateScheduleItems: allOf: - properties: amount: description: | The amount of the invoice to be generated during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. format: number type: string id: description: | The unique ID of the invoice schedule item to be updated. If this field is not provided, a new invoice schedule item is added to the invoice schedule. type: string name: description: | The name of the invoice schedule item. maxLength: 100 type: string percentage: description: | The percentage of the total amount to be billed during the processing of the invoice schedule item. You can only specify either the `amount` field or `percentage` field in one request. - If you choose to specify the `amount` field in the request, `null` is returned as the value of the `percentage` field in the corresponding response. - If you choose to specify the `percentage` field in the request, the value of the `amount` field returned in the corresponding response is calculated based on the percentage of the total amount. runDate: description: | The date in the tenant’s time zone when the invoice schedule item is planned to be processed to generate an invoice. format: date type: string targetDateForAdditionalSubscriptions: description: | The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field. format: date type: string type: object - $ref: '#/components/schemas/InvoiceScheduleItemCustomFields' - {} title: scheduleItems POSTExecuteInvoiceScheduleRequest: allOf: - properties: scheduleItemId: description: | The ID of the invoice schedule item to be executed. The item must be the earliest pending schedule item. If all the invoice schedule items have been processed and credit is needed to be generated, do not specify this field in the request. type: string type: object - {} example: scheduleItemId: 8ad09b7d82b5c62f0182c5cd16944f73 ExecuteInvoiceScheduleBillRunResponse: allOf: - properties: autoEmail: description: | Whether to automatically send an email after Auto-Post is complete. type: boolean autoPost: description: | Whether to automatically post the bill run after the bill run is created. type: boolean autoRenewal: description: | Whether to automatically renew auto-renew subscriptions that are up for renewal. type: boolean batches: description: | A list of the batches of accounts for this bill run. This field cannot exist with the `billRunFilters` field. **Values:** `AllBatches` or Batch*n* where *n* is a number between 1 and 50, for example, `Batch7`. items: type: string type: array billCycleDay: description: | The day of the bill cycle, this field is only valid when `batches` is specified. **Values:** - `AllBillCycleDays` or 1 - 31 for an ad-hoc bill run - `AllBillCycleDays` or 1 - 31 or `AsRunDay` for a scheduled bill run type: string billRunFilters: description: | A list of the target account or subscriptions for this bill run. This field cannot exist with the `batches` field. items: $ref: '#/components/schemas/BillRunFilters' type: array billRunNumber: description: | The number of bill run. type: string chargeTypeToExclude: description: | The types of the charges to be excluded from the generation of billing documents. items: enum: - OneTime - Recurring - Usage type: string type: array createdById: description: | The ID of the user who created the bill run. type: string createdDate: description: | The date and time when the bill run was created. format: date-time type: string id: description: | The unique ID of the bill run. type: string invoiceDate: description: | The invoice date for this bill run, only valid for ad-hoc bill runs. format: date type: string invoiceDateOffset: description: | The offset compared to bill run execution date, only valid for scheduled bill runs. type: integer noEmailForZeroAmountInvoice: description: | Whether to suppress emails for invoices with the total amount of zero or not for this bill run after the bill run is complete. **Note**: Do not email invoices with the total amount of zero. type: boolean organizationLabels: description: | The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array scheduledExecutionTime: description: | The scheduled execution time for a bill run. format: date-time type: string status: description: | The status of the bill run. enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: description: | The target date for this bill run, only valid for ad-hoc bill run. format: date type: string targetDateOffset: description: | The offset compared to bill run execution date, only valid for scheduled bill run. type: integer updatedById: description: | The ID of the user who updated the bill run. type: string updatedDate: description: | The date and time when the bill run was updated. format: date-time type: string type: object - {} example: autoEmail: false autoPost: false autoRenewal: false billRunFilters: - accountId: 2c9081a03c63c94c013c66688a2c00bf filterType: Subscription subscriptionId: 402882297e387c51017e38a245c313db billRunNumber: BR-00000016 chargeTypeToExclude: - OneTime - Usage createdById: ff808081298c6e5401298c7274a40005 createdDate: '2022-01-24 19:58:27' id: 2c9890077e8a8490017e8bf3a5171a43 invoiceDate: '2020-02-01' noEmailForZeroAmountInvoice: false status: Pending success: true targetDate: '2020-02-01' updatedById: ff808081298c6e5401298c7274a40005 updatedDate: '2022-01-24 19:58:27' BillRunFilters: allOf: - properties: accountId: description: | The target account of the bill run. type: string filterType: description: | The type of the filter to determine whether to create a bill run at the account level or subscription level. enum: - Account - Subscription - InvoiceSchedule type: string subscriptionId: description: | The unique ID of the target subscription belonged to the target account. This field is required if you set the `filterType` field to `Subscription`. type: string type: object - {} title: billRunFilters DetachInvoiceScheduleRequest: example: specificSubscriptions: - orderKey: O-00017019 subscriptionKey: A-S00008953 chargeNumbers: - C-00065317 properties: specificSubscriptions: description: | A list of charge numbers to be detached from the invoice schedule. Each item in this array represents a specific subscription associated with the invoice schedule. Use the `chargeNumbers` field to specify all the charges you want to detach for each subscription. items: type: object properties: chargeNumbers: description: | A list of charge numbers in the subscription to be detached from the invoice schedule. If you want to detach all charges, you must specify all of the charge numbers in this field. type: string orderKey: description: | The unique ID or number of the order associated with the invoice schedule. type: string subscriptionKey: description: | The unique number of the subscription contained in the order associated with the invoice schedule. type: string title: specificSubscriptions type: array type: object AttachInvoiceScheduleRequest: example: specificSubscriptions: - orderKey: O-00017019 subscriptionKey: A-S00008953 chargeNumbers: - C-00065317 properties: specificSubscriptions: description: | A list of charge numbers to be attached to the invoice schedule. Each item in this array represents a specific subscription associated with the invoice schedule. Use the `chargeNumbers` field to specify all the charges you want to attach for each subscription. items: type: object properties: chargeNumbers: description: | A list of charge numbers in the subscription to be attached to the invoice schedule. If you want to attach all charges, you must specify all of the charge numbers in this field. type: string orderKey: description: | The unique ID or number of the order associated with the invoice schedule. type: string subscriptionKey: description: | The unique number of the subscription contained in the order associated with the invoice schedule. type: string title: specificSubscriptions type: array type: object ProxyCreateTaxationItem: allOf: - properties: AccountingCode: description: ' The Chart of Accounts ' type: string ExemptAmount: description: |2- The calculated tax amount excluded due to the exemption. **Character limit**: 16 **Values**: a decimal value format: double type: number InvoiceItemId: description: |2- The ID of the specific invoice item that the taxation information applies to. **Character limit**: 32 **Values**: a valid invoice item ID type: string Jurisdiction: description: |2- The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. **Character limit**: 32 **Values**: a string of 32 characterrs or fewer type: string LocationCode: description: |2- The identifier for the location based on the value of the `TaxCode` field. **Character limit**: 32 **Values**: automatically generated type: string Name: description: |2- The name of the tax rate, such as sales tax or GST. This name is displayed on invoices. **Character limit**: 128 **Values**: a string of 128 characters or fewer type: string TaxAmount: description: |2- The amount of the tax applied to the charge. **Character limit**: 16 **Values**: a decimal value format: double type: number TaxCode: description: |2- The tax code identifies which tax rules and tax rates to apply to a specific charge. **Character limit**: 32 **Values**: a string of 32 characters or fewer type: string TaxCodeDescription: description: |2- The description for the tax code. **Character limit**: 255 **Values**: a string of 255 characters or fewer type: string TaxDate: description: |2- The date that the tax is applied to the charge, in `yyyy-mm-dd` format. **Character limit**: 29 format: date type: string TaxRate: description: |2- The tax rate applied to the charge. **Character limit**: 16 **Values**: a valid decimal value format: double type: number TaxRateDescription: description: |2- The description of the tax rate. **Character limit**: 255 **Values**: a string of 255 characters or fewer type: string TaxRateType: description: |2- The type of the tax rate applied to the charge. **Character limit**: 10 **Values**: `Percentage`, `FlatFee` type: string required: - InvoiceItemId - Jurisdiction - Name - TaxAmount - TaxRate - TaxDate - TaxRateType type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' example: InvoiceItemId: 8ad086fa92d66ffe0192dc7e5dd65161 Jurisdiction: CALIFORNIA Name: CA TAX TaxAmount: 3 TaxDate: '2024-11-04' TaxRate: 3 TaxRateType: FlatFee GETTaxationItemType: allOf: - properties: createdById: description: | The ID of the Zuora user who created the taxation item. type: string createdDate: description: | The date and time when the taxation item was created in the Zuora system, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. type: string onAccountAccountingCodeType: description: | The type of the accounting code that maps to an on account in your accounting system. type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. type: string salesTaxPayableAccountingCodeType: description: | The type of the accounting code for the sales taxes payable. type: string type: object id: description: | The ID of the taxation item. type: string jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string memoItemId: description: | The ID of the credit or debit memo associated with the taxation item. type: string name: description: | The name of the taxation item. type: string sourceTaxItemId: description: | The ID of the taxation item of the invoice, which the credit or debit memo is created from. type: string success: description: Returns `true` if the request was processed successfully. type: boolean taxAmount: description: | The amount of the tax applied to the credit or debit memo. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date when the tax is applied to the credit or debit memo. format: date type: string taxRate: description: | The tax rate applied to the credit or debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the credit or debit memo. enum: - Percentage - FlatFee type: string updatedById: description: | The ID of the Zuora user who last updated the taxation item. type: string updatedDate: description: | The date and time when the taxation item was last updated, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' PUTTaxationItemType: allOf: - properties: exemptAmount: description: | The calculated tax amount excluded due to the exemption. format: double type: number financeInformation: description: | Container for the finance information related to the taxation item. properties: onAccountAccountingCode: description: | The accounting code that maps to an on account in your accounting system. maxLength: 100 minLength: 0 type: string salesTaxPayableAccountingCode: description: | The accounting code for the sales taxes payable. maxLength: 100 minLength: 0 type: string type: object jurisdiction: description: | The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city. type: string locationCode: description: | The identifier for the location based on the value of the `taxCode` field. type: string name: description: | The name of the taxation item to be updated. type: string taxAmount: description: | The amount of the tax applied to the credit or debit memo. format: double type: number taxCode: description: | The tax code identifies which tax rules and tax rates to apply to a specific credit or debit memo. type: string taxCodeDescription: description: | The description of the tax code. type: string taxDate: description: | The date when the tax is applied to the credit or debit memo. format: date type: string taxRate: description: | The tax rate applied to the credit or debit memo. format: double type: number taxRateDescription: description: | The description of the tax rate. type: string taxRateType: description: | The type of the tax rate applied to the credit or debit memo. enum: - Percentage - FlatFee type: string type: object - $ref: '#/components/schemas/TaxationItemObjectCustomFields' example: taxRateDescription: Details of the tax rate GETSequenceSetsResponse: description: '' properties: sequenceSets: description: | Array of sequence sets configured for billing documents, payments, and refunds. items: $ref: '#/components/schemas/GETSequenceSetResponse' type: array success: description: | Indicates whether the call succeeded. type: boolean type: object GETSequenceSetResponse: description: '' properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' id: description: | The unique ID of the sequence set. For example, 402892c74c9193cd014c96bbe7c101f9. type: string invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: description: | The name of the sequence set. type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' title: sequenceSets type: object CreditMemoEntityPrefix: description: | Container for the prefix and starting document number of credit memos. **Note:** This field is only available if you have the Invoice Settlement feature 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. properties: prefix: description: | The prefix of credit memos. example: CM type: string startNumber: description: | The starting document number of credit memos. example: 10 type: integer title: creditMemo type: object DebitMemoEntityPrefix: description: | Container for the prefix and starting document number of debit memos. **Note:** This field is only available if you have the Invoice Settlement feature 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. properties: prefix: description: | The prefix of debit memos. example: DM type: string startNumber: description: | The starting document number of debit memos. example: 10 type: integer title: debitMemo type: object InvoiceEntityPrefix: description: | Container for the prefix and starting document number of invoices. properties: prefix: description: | The prefix of invoices. example: INV type: string startNumber: description: | The starting document number of invoices. example: 10 type: integer title: Invoice type: object PaymentEntityPrefix: description: | Container for the prefix and starting number of payments. properties: prefix: description: | The prefix of payments. example: P- type: string startNumber: description: | The starting number of payments. example: 10 type: integer title: payment type: object RefundEntityPrefix: description: | Container for the prefix and starting number of refunds. properties: prefix: description: | The prefix of refunds. example: R- type: string startNumber: description: | The starting number of refunds. example: 10 type: integer title: refund type: object POSTSequenceSetsRequest: description: '' example: sequenceSets: - name: FR creditMemo: prefix: FCM startNumber: 10 debitMemo: prefix: FDM startNumber: 10 invoice: prefix: FINV startNumber: 10 payment: prefix: FP- startNumber: 10 refund: prefix: FR- startNumber: 10 properties: sequenceSets: description: | Array of sequence sets configured for billing documents, payments, and refunds. items: $ref: '#/components/schemas/POSTSequenceSetRequest' type: array type: object POSTSequenceSetsResponse: description: '' properties: sequenceSets: description: | Array of sequence sets configured for billing documents, payments, and refunds. items: $ref: '#/components/schemas/GETSequenceSetResponse' type: array success: description: | Indicates whether the call succeeded. example: true type: boolean type: object POSTSequenceSetRequest: description: '' properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: description: | The name of the sequence set to configure for billing documents, payments, and refunds. example: FRANCE type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' required: - name - invoice - creditMemo - debitMemo title: sequenceSets type: object PUTSequenceSetRequest: description: '' example: creditMemo: prefix: FR-CM properties: creditMemo: $ref: '#/components/schemas/CreditMemoEntityPrefix' debitMemo: $ref: '#/components/schemas/DebitMemoEntityPrefix' invoice: $ref: '#/components/schemas/InvoiceEntityPrefix' name: description: | The name of the sequence set configured for billing documents, payments, and refunds. type: string payment: $ref: '#/components/schemas/PaymentEntityPrefix' refund: $ref: '#/components/schemas/RefundEntityPrefix' type: object PUTSequenceSetResponse: description: '' properties: success: description: | Indicates whether the call succeeded. type: boolean type: object PostBillingPreviewParam: example: accountId: 8ad09bce83f1da020183f97e245c1c47 targetDate: '2024-09-30' properties: accountId: description: | The ID of the customer account to which the billing preview applies. **Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body. maxLength: 255 type: string accountNumber: description: | The number of the customer account to which the billing preview applies. **Note**: When posting billing preview, you must specify either `accountId` or `accountNumber` in the request body. type: string assumeRenewal: description: | Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed. Set one of the following values in this field to decide how the assumption is applied in the billing preview. * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date. * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date. * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. **Note:** - This field can only be used if the subscription renewal term is not set to 0. - The credit memo item data is only available if you have Invoice Settlement feature 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. type: string chargeTypeToExclude: description: | The charge types to exclude from the billing preview. **Possible values:** OneTime, Recurring, Usage, and any combination of these values. type: string includingDraftItems: description: | Whether draft document items are included in the billing preview run. By default, draft document items are not included. This field loads draft invoice items and credit memo items. The `chargeTypeToExclude`, `targetDate`, `includingEvergreenSubscription`, and `assumeRenewal` fields do not affect the behavior of the `includingDraftItems` field. type: boolean includingEvergreenSubscription: description: | Indicates if evergreen subscriptions are included in the billingPreview call. type: boolean targetDate: description: | The target date for the billingPreview call. The billingPreview call generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the TargetDate. If the TargetDate is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the `AssumeRenewal` field in the request. **Note:** The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. format: date type: string required: - targetDate type: object BillingPreviewResult: properties: accountId: description: | ID of the customer account to which the billing preview applies. type: string creditMemoItems: description: | An array of credit memo items returned as the result of the billing preivew request. **Note:** The credit memo items are only available if you have Invoice Settlement feature 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. items: $ref: '#/components/schemas/POSTBillingPreviewCreditMemoItem' type: array invoiceItems: description: | An array of invoice items returned as the result of the billing preview request. items: $ref: '#/components/schemas/POSTBillingPreviewInvoiceItem' type: array success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTBillingPreviewCreditMemoItem: properties: amount: description: | The amount of the credit memo item. For tax-inclusive credit memo items, the amount indicates the credit memo item amount including tax. For tax-exclusive credit memo items, the amount indicates the credit memo item amount excluding tax format: double type: number amountWithoutTax: description: | The credit memo item amount excluding tax. format: double type: number appliedToItemId: description: | The unique ID of the credit memo item that the discount charge is applied to. type: string nullable: true chargeDate: description: | The date when the credit memo item is created. format: date-time type: string chargeNumber: description: | Number of the charge. type: string chargeType: description: | The type of charge. Possible values are `OneTime`, `Recurring`, and `Usage`. type: string comment: description: | Comment of the credit memo item. type: string id: description: | Credit memo item id. type: string numberOfDeliveries: description: | The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. type: number processingType: description: | Identifies the kind of charge. Possible values: * charge * discount * prepayment * tax type: string quantity: description: | Quantity of this item, in the configured unit of measure for the charge. format: decimal type: string ratePlanChargeId: description: | Id of the rate plan charge associated with this item. type: string serviceEndDate: description: | End date of the service period for this item, i.e., the last day of the service period, in yyyy-mm-dd format. format: date type: string serviceStartDate: description: | Start date of the service period for this item, in yyyy-mm-dd format. If the charge is a one-time fee, this is the date of that charge. format: date type: string sku: description: | Unique SKU for the product associated with this item. type: string skuName: description: | Name of the unique SKU for the product associated with this item. type: string subscriptionId: description: | ID of the subscription associated with this item. type: string subscriptionNumber: description: | Name of the subscription associated with this item. type: string unitOfMeasure: description: | Unit used to measure consumption. type: string title: creditMemoItems type: object POSTBillingPreviewInvoiceItem: properties: appliedToItemId: description: | The unique ID of the invoice item that the discount charge is applied to. type: string nullable: true chargeAmount: description: | The amount of the charge. This amount doesn't include taxes regardless if the charge's tax mode is inclusive or exclusive. format: decimal type: string chargeDate: description: | The date when the invoice item was created. format: date-time type: string chargeDescription: description: | Description of the charge. type: string chargeId: description: | Id of the charge. type: string chargeName: description: | Name of the charge. type: string chargeNumber: description: | Number of the charge. type: string chargeType: description: | The type of charge. Possible values are `OneTime`, `Recurring`, and `Usage`. type: string id: description: | Invoice item ID. type: string numberOfDeliveries: description: | The number of deliveries dedicated to the Delivery Pricing charges. **Note**: This field is available only if you have the Delivery Pricing feature enabled. type: number processingType: description: | Identifies the kind of charge. Possible values: * charge * discount * prepayment * tax type: string productName: description: | Name of the product associated with this item. type: string quantity: description: | Quantity of this item, in the configured unit of measure for the charge. format: decimal type: string serviceEndDate: description: | End date of the service period for this item, i.e., the last day of the service period, in `yyyy-mm-dd` format. format: date type: string serviceStartDate: description: | Start date of the service period for this item, in `yyyy-mm-dd` format. If the charge is a one-time fee, this is the date of that charge. format: date type: string subscriptionId: description: | ID of the subscription associated with this item. type: string subscriptionName: description: | Name of the subscription associated with this item. type: string subscriptionNumber: description: | Number of the subscription associated with this item. type: string taxAmount: description: | If you use [Zuora Tax](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax) and the product rate plan charge associated with the invoice item is of [tax inclusive mode](https://knowledgecenter.zuora.com/Billing/Taxes/A_Zuora_Tax/D_Associate_tax_codes_with_product_charges_and_set_the_tax_mode), the value of this field is the amount of tax applied to the charge. Otherwise, the value of this field is `0`. format: decimal type: string unitOfMeasure: description: | Unit used to measure consumption. type: string title: invoiceItems type: object POSTInvoiceCollectType: example: accountKey: 4028925a4cb74ec9014cb7520fc00005 invoiceId: 4028925a4cb74ec9014cb7540988002e properties: accountKey: description: | Customer account ID or account number. type: string documentDate: description: | The date that should appear on the invoice and credit memo being generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled. **Note**: This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `215.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string invoiceId: description: | The ID or number of an existing invoice for which to collect payment using the account's default payment method. If this value is specified, no new invoice is generated, and the following fields are ignored: - `invoiceDate` and `invoiceTargetDate` (if the Zuora minor API version is 214.0 or earlier) - `documentDate` and `targetDate` (if the Zuora minor API version is 215.0 or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version)) type: string paymentGateway: description: | The name of the gateway that will be used for the payment. Must be a valid gateway name and the gateway must support the specific payment method. If a value is not specified, the default gateway on the Account will be used. type: string targetDate: description: | The date through which to calculate charges on this account if an invoice or a credit memo is generated, in `yyyy-mm-dd` format. If this field is omitted and `invoiceId` is not specified, the current date is used by default. This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `215.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). **Note:** The credit memo is only available if you have the Invoice Settlement feature enabled. format: date type: string required: - accountKey type: object POSTInvoiceCollectResponseType: properties: amountCollected: description: | Payment amount applied. format: double type: number creditMemos: description: | Information on one or more credit memos associated with this operation. items: $ref: '#/components/schemas/POSTInvoiceCollectCreditMemosType' type: array invoices: description: | Information on one or more invoices associated with this operation. items: $ref: '#/components/schemas/POSTInvoiceCollectInvoicesType' type: array paymentId: description: | Payment ID. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTInvoiceCollectCreditMemosType: properties: id: description: | The ID of the credit memo. type: string totalAmount: description: | The amount of the credit memo. format: double type: number memoNumber: description: | The unique identification number of the credit memo. type: string title: creditMemos type: object POSTInvoiceCollectInvoicesType: properties: invoiceAmount: description: | The amount of the invoice. format: decimal type: string invoiceId: description: | The ID of the invoice. type: string invoiceNumber: description: | The unique identification number of the invoice. type: string title: invoices type: object GetOperationJobResponseType: properties: id: description: | The ID of the operation job to retrieve information about. type: string objectId: description: | The ID of the business object which is being operated. type: string objectType: description: | The object type of the job. enum: - Invoice type: string operationType: description: | The operation type of the job. enum: - Delete - Reverse type: string reasons: items: properties: code: description: | The error code of the response. type: string message: description: | The detail information of the error response. type: string type: object type: array status: description: | The status of the operation job. enum: - Pending - Processing - Failed - Completed type: string success: description: | Whether the call succeeded. type: boolean type: object POSTBulkPdfGenerationJobRequestType: allOf: - type: object required: - documents - fileName - indexFileFormat example: documents: - docType: Invoice objectIds: - 402880de8ce7edc3018ce7f18404315a - 402880de8ce7edc3018ce7f18e0b3804 fileName: all-invoices-posted-jan-2024 name: BulkPDFGenerationJobV1 indexFileFormat: JSON generateMissingPDF: true ignoreArchivedFiles: true properties: documents: description: | An array that contains a collection of objects where each object contains billing document type and their IDs. items: $ref: '#/components/schemas/DocumentList' type: array fileName: description: | The prefix part of output file name(s). The response will include multiple file URLs. The number of zip files generated corresponds to the number of invoice IDs. Each zip file contains up to 1000 document IDs. Eg: if fileName is "all-invoices-posted-jan-2024" then fileURL(s) will start with the file name followed by an underscore and a number. For instance, all-invoices-posted-jan-2024_1.zip, all-invoices-posted-jan-2024_2.zip, and so on. type: string maxLength: 32 name: description: | The name of the job. type: string maxLength: 32 indexFileFormat: description: | The format of the index file. It contains the metadata about the files and their contents. enum: - JSON - CSV type: string generateMissingPDF: description: | This flag controls the behavior of whether to generate PDF(s) for billing documents that do not already have one. - setting it to true indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF, generate them all at once, and then proceed to the zipping process. - setting it to false indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF, mark them as Invalid, and skip them from the zipping process. IDs marked as invalid will be included in the response. The default value is false. type: boolean ignoreArchivedFiles: description: | Ignores archived PDF files during export without causing the entire job request to fail when enabled. type: boolean persistIndexFile: description: | Controls the generation of the index file, allowing you to efficiently handle high volumes of requests. By default, this field is set to `true`. - When set to `true`, the index file is generated and included in the zip file. - When set to `false`, the index file is not generated and consequently not included in the zip file. type: boolean POSTBulkPdfGenerationJobResponseType: example: jobId: 402880de8ce7edc3018ce7f18404312a invalidIds: [] success: true allOf: - $ref: '#/components/schemas/CommonResponse' - properties: jobId: description: | Unique Id for the Job Triggered. type: string invalidIds: description: | Collection of Ids that are not valid. Id is considered to be invalid if, * Billing Document Id doesn't exist in the database for the corresponding Billing Document Type * generateMissingPDF property is false in the Job Request and Valid PDF doesn't exist for the Billing Document Id skippedDocuments: description: | The `skippedDocuments` array will be empty unless archived files are marked to skip during job creation. items: type: object properties: docType: description: | The document type of the skipped document. enum: - Invoice - CreditMemo - DebitMemo type: string objectIds: description: | The IDs of the skipped document objects. type: array items: type: string type: array type: object DocumentList: example: docType: Invoice objectIds: - 402880de8ce7edc3018ce7f18404315a - 402880de8ce7edc3018ce7f18e0b3804 properties: docType: description: The type of billing document. enum: - Invoice - CreditMemo - DebitMemo type: string objectIds: description: The collection of billing document IDs. items: type: string type: array type: object GETBulkpdfGenerationJobResponseType: example: jobId: 402880de8ce7edc3018ce7f18404312a jobName: BulkPDFGenerationJobV1 status: Completed stepStatus: PostProcessing fileUrls: - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_1.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 - https://s3.us-west-2.amazonaws.com/billing-file-repository/bulk-pdf-generation/12345/all-invoices-posted-jan-2024_2.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20231222T075849Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259199&X-Amz-Credential=fakeMyKeyId%2F20231222%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=62368dbec1763101fba328cf83ae7d3efd780fa03f443370d2f353757e79fc99 createdOn: '2024-01-08 12:52:05' createdBy: caf630704a6f4100818601625ecffe0b success: true properties: jobId: description: Unique Id for the Triggered Job type: string jobName: description: Name of the Job provided during the POST request of the Job type: string status: description: Status of the job enum: - Submitted - Executing - Completed - Error - Aborted - Cancelled type: string stepStatus: description: Status of the Current Step that the Job is undergoing enum: - JobCreated - TasksCreated - GenerateMissPDF - PdfToZip - PostProcessing type: string fileUrls: description: Collection of S3 Pre-Signed URL(s) that can be downloaded items: type: string type: array failedDocuments: description: Array of objects where each object contains billing document type and the IDs which failed to execute. items: $ref: '#/components/schemas/DocumentList' type: array createdOn: description: Job Created Time type: string createdBy: description: Id of the user who created the job type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object POSTCreateBillRunRequestType: allOf: - properties: autoEmail: default: false description: | Whether to automatically send emails after Auto-Post is complete. **Note:** To use this field, you must first set the Support Bill Run Auto-Post? billing rule to **Yes** through the Zuora UI. type: boolean autoPost: default: false description: | Whether to automatically post the bill run after the bill run is created. **Note:** To use this field, you must first set the Support Bill Run Auto-Post? billing rule to **Yes** through the Zuora UI. type: boolean autoRenewal: default: false description: | Whether to automatically renew auto-renew subscriptions that are up for renewal. type: boolean batches: description: | The batch of accounts for this bill run. You can only specify either this field or the `billRunFilters` field. **Values:** `AllBatches` or an array of `Batch*n*` where *n* is one of numbers 1 - 50, for example, `Batch7`. **Note**: By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package. items: type: string type: array billCycleDay: description: | The day of the bill cycle. This field is only valid if the `batches` field is specified. **Values:** - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run type: string billRunFilters: description: | The target account, subscriptions, invoice schedule, or a combination of objects for this bill run. You can only specify either this field or the `batches` field. items: $ref: '#/components/schemas/BillRunFilterRequestType' type: array billRunType: description: | The type of the bill run. If you do not specify any value for this field, the default value is `Regular`. - You can use this field only if the "Catch-Up Bill Run" feature is enabled. - You must specify this field to create a catch up bill run. **Values:** - `Regular` - `CatchUp` type: string chargeTypeToExclude: description: | The types of the charges to be excluded from the generation of billing documents. You can specify at most two charge types in the array. items: enum: - OneTime - Recurring - Usage type: string type: array includeSubscriptions: default: true description: | Indicates whether to bill subscriptions in the bill run. type: boolean includeOrderLineItems: default: true description: | Indicates whether to bill order line items in the bill run. type: boolean invoiceDate: description: | The invoice date for the bill run. - When creating an ad-hoc bill run, if you do not specify any value for this field, the default value is the current date. - When creating a scheduled bill run, if you do not specify any value for this field, the invoice date is the value of the `repeatFrom` field. **Note**: You can use one of the following methods to specify the invoice date: - Specify `invoiceDate` - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth` format: date type: string invoiceDateMonthOffset: description: | The month offset of invoice date for this bill run compared to bill run execution date. **Notes**: - This field is only valid when the `repeatType` field is set to `Monthly`. - You can use one of the following methods to specify the invoice date: - Specify `invoiceDate` - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth` type: integer invoiceDateDayOfMonth: description: | The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month. **Notes**: - This field is only valid when the `repeatType` field is set to `Monthly`. - You can use one of the following methods to specify the invoice date: - Specify `invoiceDate` - Specify `invoiceDateMonthOffset` and `InvoiceDateDayOfMonth` type: integer maximum: 31 minimum: 1 name: description: | The name of the bill run. type: string noEmailForZeroAmountInvoice: default: false description: | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. It is best practice to not send emails for invoices with zero amount. type: boolean organizationLabels: description: | The organization(s) that the bill run is created for. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array schedule: $ref: '#/components/schemas/BillRunScheduleRequestType' targetDate: description: | The target date for this bill run. - You must specify this field when creating an ad-hoc bill run. - For scheduled bill runs, if you do not specify any value for this field, the target date is the value of the `repeatFrom` field. format: date type: string targetDateMonthOffset: description: | The month offset of target date for this bill run compared to bill run execution date. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. type: integer targetDateDayOfMonth: description: | The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. type: integer maximum: 31 minimum: 1 type: object example: autoEmail: false autoPost: false autoRenewal: false billRunFilters: - accountId: 2c9081a03c63c94c013c66688a2c00bf filterType: Subscription subscriptionId: 402882297e387c51017e38a245c313db chargeTypeToExclude: - OneTime - Usage invoiceDate: '2020-02-01' name: test noEmailForZeroAmountInvoice: false targetDate: '2020-02-01' GetBillRunResponseType: allOf: - properties: autoEmail: description: | Whether to automatically send emails after Auto-Post is complete. type: boolean autoPost: description: | Whether to automatically post the bill run after the bill run is created. type: boolean autoRenewal: description: | Whether to automatically renew auto-renew subscriptions that are up for renewal. type: boolean batches: description: | The batch of accounts for this bill run, this field can not exist with `billRunFilters` together. **Values:** `AllBatches` or an array of `Batch`*n* where *n* is a number between 1 and 50, for example, `Batch7`. items: type: string type: array billCycleDay: description: | The day of the bill cycle, this field is only valid when `batches` is specified. **Values:** - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run type: string billRunFilters: description: | The target account, subscriptions, invoice schedule, or a combination of objects for this bill run. You can only specify either this field or the `batches` field. items: $ref: '#/components/schemas/BillRunFilterResponseType' type: array billRunNumber: description: | The number of the bill run. type: string chargeTypeToExclude: description: | The types of the charges to be excluded from the generation of billing documents. items: enum: - OneTime - Recurring - Usage type: string type: array createdById: description: | The ID of the user who created the bill run. type: string createdDate: description: | The date and time when the bill run was created. format: date-time type: string includeSubscriptions: default: true description: | Indicates whether to bill subscriptions in the bill run. type: boolean includeOrderLineItems: default: true description: | Indicates whether to bill order line items in the bill run. type: boolean id: description: | The unqie ID of the bill run. type: string invoiceDate: description: | The invoice date for this bill run, only valid for ad-hoc bill runs. format: date type: string invoiceDateOffset: description: | The offset compared to bill run execution date, only valid for scheduled bill runs. type: integer invoiceDateMonthOffset: description: | The month offset of invoice date for this bill run compared to bill run execution date. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. When using the `invoiceDateMonthOffset` and `invoiceDateDayOfMonth` fields, do not use the `invoiceDateOffset` field, and vice versa. type: integer invoiceDateDayOfMonth: description: | The day of month of invoice date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. When using the `invoiceDateMonthOffset` and `invoiceDateDayOfMonth` fields, do not use the `invoiceDateOffset` field, and vice versa. type: integer maximum: 31 minimum: 1 name: description: | The name of the bill run. type: string noEmailForZeroAmountInvoice: description: | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. type: boolean organizationLabels: description: | The organization(s) that the run is created for. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array schedule: $ref: '#/components/schemas/BillRunScheduleResponseType' scheduledExecutionTime: description: | The scheduled execution time for a bill run. format: date-time type: string status: description: | The status of the bill run. enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: description: | The target date for this bill run, only valid for ad-hoc bill runs. format: date type: string targetDateOffset: description: | The offset compared to bill run execution date, only valid for scheduled bill runs. type: integer targetDateMonthOffset: description: | The month offset of target date for this bill run compared to bill run execution date. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. When using the `targetDateMonthOffset` and `targetDateDayOfMonth` fields, do not use the `targetDateOffset` field, and vice versa. type: integer targetDateDayOfMonth: description: | The day of month of target date for this bill run. Specify a day of the month. If you specify 31, even though the month doesn't have 31, for example, February or April, the date recurs on the end day of each scheduled month. **Note**: This field is only valid when the `repeatType` field is set to `Monthly`. When using the `targetDateMonthOffset` and `targetDateDayOfMonth` fields, do not use the `targetDateOffset` field, and vice versa. type: integer maximum: 31 minimum: 1 updatedById: description: | The ID of the user who last updated the bill run. type: string updatedDate: description: | The date and time when the bill run was last updated. format: date-time type: string type: object example: autoEmail: false autoPost: false autoRenewal: false batches: null billCycleDay: 1 billRunFilters: - accountId: 2c9081a03c63c94c013c66688a2c00bf filterType: Subscription subscriptionId: 402882297e387c51017e38a245c313db billRunNumber: BR-00000016 chargeTypeToExclude: - OneTime - Usage createdById: ff808081298c6e5401298c7274a40005 createdDate: '2022-01-24 19:58:27' id: 2c9890077e8a8490017e8bf3a5171a43 invoiceDate: '2020-02-01' invoiceDateOffset: null name: test noEmailForZeroAmountInvoice: false schedule: null scheduledExecutionTime: null status: Pending success: true targetDate: '2020-02-01' targetDateOffset: null updatedById: ff808081298c6e5401298c7274a40005 updatedDate: '2022-01-24 19:58:27' BillRunFilterResponseType: allOf: - properties: accountId: description: | The target account of the bill run. type: string filterType: description: | The bill runs are created based on the selected filter type: - `Account`: Create a bill run at account level. - `Subscription`: Create a bill run at subscription level, you must specify the `subscriptionId` field. - `InvoiceSchedule`: Create a scheduled bill run, you must specify the `schedule` field. See Manage scheduled bill runs. - `FilterCondition`: Create a bill run based on a custom filter, you must specify the `condition` and `objectType` fields. See Bill Run Advanced Filter. enum: - Account - Subscription - InvoiceSchedule - FilterCondition type: string condition: $ref: '#/components/schemas/Condition' objectType: description: | The target object type of the condition when the `filterType` field is specified as `FilterCondition`. See Bill Run Advanced Filter. type: string enum: - Account - Subscription - RatePlanCharge subscriptionId: description: | The target subscripiton ID of the account. type: string type: object title: billRunFilters BillRunScheduleResponseType: allOf: - description: | Container for information about the scheduled bill run. properties: repeatFrom: description: | The start date of the scheduled bill run. format: date type: string repeatTo: description: | The end date of of the scheduled bill run. format: date type: string repeatType: description: | The repeat type of the bill run. enum: - None - Daily - Weekly - Monthly type: string runTime: description: | The scheduled run time (hour) of day. **Values:** 0 - 23 type: integer weeklyOnDay: description: | The repeat day in a week. items: enum: - Mon - Tue - Wed - Thu - Fri - Sat - Sun type: string type: array monthlyOnEndOfMonth: description: | Whether to schedule monthly bill run on the end of month or the specific day of month. **Note**: This field is available only when the `repeatType` field is set to `Monthly` and the `repeatFrom` field is set to the end of month. For example: - When repeatFrom = `2024-04-30` and monthlyOnEndOfMonth = `true`, next bill run will be scheduled on `2024-05-31`. - When repeatFrom = `2024-04-30` and monthlyOnEndOfMonth = `false`, next bill run will be scheduled on `2024-05-30`. type: boolean type: object title: schedule Condition: allOf: - description: Container for condition information about the Bill Run Advanced Filter. properties: conditions: description: | Multiple `conditions` fields are combined by the `relation` fields. These `conditions` fields form a custom filter. Each `conditions` field is a formula combined by the `field`, `operator`, and `value` fields. See Common use cases of Bill Run Advanced Filter. type: array items: $ref: '#/components/schemas/Condition' field: description: | The field name of a single condition that is indicated by the `conditions` field. type: string operator: description: | The operator of a single condition that is indicated by the `conditions` field. The operator is added between the `field` and `value` fields. - eq: equal (`field` = `value`) - neq: not equal (`field` != `value`) - gt: greater than (`field` > `value`) - lt: less than (`field` < `value`) - gte: greater than or equal (`field` >= `value`) - lte: less than or equal (`field` <= `value`) - lk: like (`field` like `value`) - in: in (`field` in `value`, the values are separated by comma) - nl: null (`field` is null) - nnl: not null (`field` is not null) type: string enum: - eq - neq - gt - lt - gte - lte - lk - in - nl - nnl relation: description: | The relation among the `conditions` fields. type: string enum: - and - or value: description: | The value of a single condition that is indicated by the `conditions` field. type: string type: object title: Condition BillRunFilterRequestType: allOf: - properties: accountId: description: | The target account of the bill run. If multiple subscriptions are specified, the account ID must be the same. type: string filterType: description: | To create bill runs based on the selected filter type: - `Account`: Create bill runs by account. - `Subscription`: Create bill runs by subscription, you must specify the `subscriptionId` field. - `FilterCondition`: Create bill runs by custom filter combining the Account, Subscription, and Rate Plan objects, you must specify the `condition` and `objectType` fields. See Bill Run Advanced Filter. enum: - Account - Subscription - FilterCondition type: string condition: $ref: '#/components/schemas/Condition' objectType: description: | The target object type of the condition when the `filterType` field is specified as `FilterCondition`. See Bill Run Advanced Filter. type: string enum: - Account - Subscription - RatePlanCharge subscriptionId: description: | The target subscripiton ID of the account. If you set the `filterType` field to `Subscription`, you must specify the `subscriptionId` field. type: string required: - accountId - filterType type: object title: billRunFilters BillRunScheduleRequestType: allOf: - description: | Container for information about the scheduled bill run. properties: repeatFrom: description: | The start date of the scheduled bill run. format: date type: string repeatTo: description: | The end date of of the scheduled bill run. format: date type: string repeatType: description: | The repeat type of the bill run. enum: - None - Daily - Weekly - Monthly type: string runTime: description: | The scheduled run time (hour) of day. **Values:** 0 - 23 type: integer weeklyOnDay: description: | The repeat day in a week. This field is required if you set `repeatType` field to `Weekly`. items: enum: - Mon - Tue - Wed - Thu - Fri - Sat - Sun type: string type: array monthlyOnEndOfMonth: description: | Whether to schedule monthly bill run on the end of month or the specific day of month. **Note**: This field is available only when the `repeatType` field is set to `Monthly` and the `repeatFrom` field is set to the end of month. For example: - When repeatFrom = `2024-04-30` and `monthlyOnEndOfMonth` = `true`, next bill run will be scheduled on `2024-05-31`. - When repeatFrom = `2024-04-30` and `monthlyOnEndOfMonth` = `false`, next bill run will be scheduled on `2024-05-30`. type: boolean required: - repeatFrom - repeatType - runTime type: object title: schedule CancelBillRunResponseType: allOf: - $ref: '#/components/schemas/GetBillRunResponseType' - properties: nextRun: $ref: '#/components/schemas/NextRunResponseType' type: object example: autoEmail: false autoPost: false autoRenewal: true batches: null billCycleDay: 1 billRunFilters: [] billRunNumber: BR-00000014 chargeTypeToExclude: null createdById: ff808081298c6e5401298c7274a40005 createdDate: '2022-01-19 11:28:34' id: 2c9890e97e57e546017e706109df04a1 invoiceDate: '2022-01-26' invoiceDateOffset: 0 name: test nextRun: autoEmail: false autoPost: false autoRenewal: true batches: null billCycleDay: 1 billRunFilters: [] billRunNumber: BR-00000021 chargeTypeToExclude: null createdById: ff808081298c6e5401298c7274a40005 createdDate: '2022-01-26 14:47:05' id: 2c9890077e901749017e95235b13093d invoiceDate: null invoiceDateOffset: 0 noEmailForZeroAmountInvoice: false schedule: repeatFrom: '2022-02-28' repeatTo: '2023-01-31' repeatType: Monthly runTime: 0 weeklyOnDay: null scheduledExecutionTime: '2022-02-28 00:00:00' status: Pending targetDate: null targetDateOffset: 0 updatedById: ff808081298c6e5401298c7274a40005 updatedDate: '2022-01-26 14:47:05' noEmailForZeroAmountInvoice: false schedule: null scheduledExecutionTime: '2022-01-28 00:00:00' status: CancelInProgress success: true targetDate: null targetDateOffset: 0 updatedById: ff808081298c6e5401298c7274a40005 updatedDate: '2022-01-26 14:47:09' NextRunResponseType: allOf: - description: | Container about information about the next bill run to be executed. properties: autoEmail: description: | Whether to automatically send emails after Auto-Post is complete. type: boolean autoPost: description: | Whether to automatically post the bill run after the bill run is created. type: boolean autoRenewal: description: | Whether to automatically renew auto-renew subscriptions that are up for renewal. type: boolean batches: description: | The batch of accounts for this bill run. **Values:** `AllBatches` or an array of `Batch`*n* where *n* is one of numbers 1 - 50, for example, `Batch7`. items: type: string type: array billCycleDay: description: | The day of the bill cycle. This field is only valid if the `batches` field is specified. **Values:** - `AllBillCycleDays` or one of numbers 1 - 31 for an ad-hoc bill run - `AllBillCycleDays`, one of numbers 1 - 31, or `AsRunDay` for a scheduled bill run type: string billRunFilters: description: | The target account or subscriptions for this bill run. items: $ref: '#/components/schemas/BillRunFilterResponseType' type: array billRunNumber: description: | The number of the bill run. type: string chargeTypeToExclude: description: | The types of the charges to be excluded from the generation of billing documents. items: enum: - OneTime - Recurring - Usage type: string type: array createdById: description: | The ID of the user who created the bill run. type: string createdDate: description: | The date and time when the bill run was created. format: date-time type: string id: description: | The ID of the bill run. type: string invoiceDate: description: | The invoice date for this bill run, only valid for ad-hoc bill runs. format: date type: string invoiceDateOffset: description: | The offset compared to the bill run execution date, only valid for scheduled bill runs. type: integer noEmailForZeroAmountInvoice: description: | Whether to suppress emails for invoices with zero total amount generated in this bill run after the bill run is complete. type: boolean schedule: $ref: '#/components/schemas/BillRunScheduleResponseType' scheduledExecutionTime: description: | The scheduled execution time for the bill run. format: date-time type: string status: description: | The status of the bill run. enum: - Pending - Processing - Completed - Error - Canceled - Posted - PostInProgress - CancelInProgress - RemoveInProgress - Paused type: string targetDate: description: | The target date for this bill run, only valid for ad-hoc bill runs. format: date type: string targetDateOffset: description: | The offset compared to the bill run execution date, only valid for scheduled bill runs. type: integer updatedById: description: | The ID of the user who last updated the bill run. type: string updatedDate: description: | The date and time when the bill run was last updated. format: date-time type: string type: object example: autoEmail: false autoPost: false autoRenewal: false batches: null billCycleDay: null billRunFilters: - accountId: 2c9081a03c63c94c013c66688a2c00bf filterType: Subscription subscriptionId: 402882297e387c51017e38a245c313db billRunNumber: BR-00000016 chargeTypeToExclude: - OneTime - Usage createdById: ff808081298c6e5401298c7274a40005 createdDate: '2022-01-24 19:58:27' id: 2c9890077e8a8490017e8bf3a5171a43 invoiceDate: '2020-02-01' invoiceDateOffset: null noEmailForZeroAmountInvoice: false schedule: null scheduledExecutionTime: null status: Pending success: true targetDate: '2020-02-01' targetDateOffset: null updatedById: ff808081298c6e5401298c7274a40005 updatedDate: '2022-01-24 19:58:27' title: nextRun POSTEmailBillingDocfromBillRunType: example: resend: 'true' properties: resend: default: false description: | Whether to send out emails for all the billing documents that are associated with the bill run. - If the value is `false`, emails are sent out only for the billing documents that never have emails sent out. **Note**: Do not perform this API operation with the `resend` field set to `false` multiple times in a short period. Otherwise, you may receive the same email multiple times, which contradicts the purpose of this setting. - If the value is `true`, emails are sent out for all the billing documents. type: boolean type: object PostBillingPreviewRunParam: example: batches: Batch1 targetDate: '2024-11-05' properties: assumeRenewal: description: | Indicates whether to generate a preview of future invoice items and credit memo items with the assumption that the subscriptions are renewed. Set one of the following values in this field to decide how the assumption is applied in the billing preview. * **All:** The assumption is applied to all the subscriptions. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. * **None:** (Default) The assumption is not applied to the subscriptions. Zuora generates preview invoice item data and credit memo item data based on the current term end date and the target date. * If the target date is later than the current term end date, Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the current term end date. * If the target date is earlier than the current term end date, Zuora generates preview invoice item data and credit memeo item data from the first day of the customer's next billing period to the target date. * **Autorenew:** The assumption is applied to the subscriptions that have auto-renew enabled. Zuora generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. **Note:** - This field can only be used if the subscription renewal term is not set to 0. - The credit memo item data is only available if you have Invoice Settlement feature 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. type: string batches: description: | The customer batches to include in the billing preview run. You can specify multiple batches separated by comma. If not specified, all customer batches are included. **Note**: - By default, you have 50 configurable account batches. To increase the limit to 200 batches, you must have the Performance Booster Elite package. - This field is available only if you are on the latest Zuora API version, or you set the `Zuora-Version` request header to `314.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). maxLength: 1000 type: string chargeTypeToExclude: description: | The charge types to exclude from the forecast run. **Possible values:** OneTime, Recurring, Usage, and any comma-separated combination of these values. type: string includingDraftItems: description: | Whether draft document items are included in the billing preview run. By default, draft document items are not included. This field loads draft invoice items and credit memo items. The `chargeTypeToExclude`, `targetDate`, `includingEvergreenSubscription`, and `assumeRenewal` fields do not affect the behavior of the `includingDraftItems` field. type: boolean includingEvergreenSubscription: description: | Whether evergreen subscriptions are included in the billing preview run. By default, evergreen subscriptions are not included. type: boolean organizationLabels: description: | The organization(s) that this billing preview run is created for. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array storageOption: description: | The saving options. The default value is `Csv`. To compare the current billing preview run result with a specified billing preview run result and store the difference in the database, you must set the `storageOption` field to `Database`. For more information, see [Billing Preview Run Result data source](https://knowledgecenter.zuora.com/Zuora_Central_Platform/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference/Billing_Preview_Run_Result_data_source). enum: - Csv - Database type: string storeDifference: description: | Specify this field to `yes` to compare the current billing preview run result with a specified billing preview run result and store the difference in the database. You can view the difference in the Billing Preview Run Result Difference data source. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support. The default value is `false`. type: boolean comparedBillingPreviewRunId: description: | Specify an existing billing preview run result to compare the current billing preview result with. You can view the difference in the Billing Preview Run Result Difference data source. **Note**: This feature is in the **Early Adopter** phase. If you want to use the feature, submit a request at Zuora Global Support. type: string targetDate: description: | The target date for the billing preview run. The billing preview run generates preview invoice item data and credit memo item data from the first day of the customer's next billing period to the target date. The value for the `targetDate` field must be in _`YYYY-MM-DD`_ format. If the target date is later than the subscription current term end date, the preview invoice item data and credit memo item data is generated from the first day of the customer's next billing period to the current term end date. If you want to generate preview invoice item data and credit memo item data past the end of the subscription current term, specify the AssumeRenewal field in the request. **Note:** The credit memo item data is only available if you have Invoice Settlement feature enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. format: date type: string required: - targetDate type: object GetBillingPreviewRunResponse: description: get billingPreviewRun response properties: assumeRenewal: description: '' type: string batches: description: | The customer batches included in the billing preview run. **Note**: This field is available only if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `314.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string chargeTypeToExclude: description: | The charge types excluded from the forecast run. type: string createdById: description: | The ID of the user who created the billing preview run. type: string createdDate: description: | The date and time when the billing preview run was created. format: datetime type: string endDate: description: | The date and time when the billing preview run completes. format: datetime type: string errorMessage: description: | The error message generated by a failed billing preview run. type: string includingDraftItems: description: | Whether draft document items are included in the billing preview run. By default, draft document items are not included. type: boolean includingEvergreenSubscription: description: | Indicates if evergreen subscriptions are included in the billing preview run. type: boolean organizationLabels: description: | The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array resultFileUrl: description: | The URL of the zipped CSV result file generated by the billing preview run. This file contains the preview invoice item data and credit memo item data for the specified customers. If the value of `storageOption` field is `Database`, the returned `resultFileUrl` field is null. **Note:** The credit memo item data is only available if you have Invoice Settlement feature 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. type: string runNumber: description: | The run number of the billing preview run. type: string startDate: description: | The date and time when the billing preview run starts. format: datetime type: string status: description: | The status of the >billing preview run. **Possible values:** * 0: Pending * 1: Processing * 2: Completed * 3: Error * 4: Canceled type: string storageOption: description: | The saving options. The default value is `Csv`. enum: - Csv - Database type: string succeededAccounts: description: | The number of accounts for which preview invoice item data and credit memo item data was successfully generated during the billing preview run. **Note:** The credit memo item data is only available if you have Invoice Settlement feature 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. type: integer success: description: Returns `true` if the request was processed successfully. type: boolean targetDate: description: | The target date for the billing preview run. format: date type: string totalAccounts: description: | The total number of accounts in the billing preview run. format: int32 type: integer updatedById: description: | The ID of the user who last updated the billing preview run. type: string updatedDate: description: | The date and time when the billing preview run was last updated. format: date-time type: string type: object POSTPaymentMethodResponse: allOf: - $ref: '#/components/schemas/CommonResponse' - properties: id: description: | Internal ID of the payment method that was created. type: string reasons: items: description: | Error information. Only applicable if the payment method was not created. properties: code: description: | Error code. type: string message: description: | Error message. type: string type: object type: array type: object POSTPaymentMethodDecryption: example: accountID: 402891a25a02e11c015a02f3c6100003 cardHolderInfo: cardHolderName: Amy Lawrence addressLine1: 101 Redwood Shores Parkway city: Redwood City country: USA integrationType: ApplePay invoiceId: INV000000005 merchantID: merchant.US.com.zuora.services001 mitConsentAgreementSrc: External mitProfileAction: Activate mitProfileType: Recurring paymentGateway: CyberSourceOPG paymentToken: data: xGc......JDxuYz1gug0KZRrGXJQ= header: ephemeralPublicKey: MFkwEw......TMbLoojKBA== publicKeyHash: HuLvfqvLon......9jEyX0w= transactionId: abbadd18818baea1f37b40844c9e09afa9733b0eccb373905b811da43cf1753b signature: MIAGCSqGSIb......AEtrLSv7hE9gAAAAAAAA== version: EC_v1 processPayment: true properties: accountID: description: |- The ID of the customer account associated with this payment method. To create an orphan payment method that is not associated with any customer account, you can skip this field. As soon as the account information is available, associate the payment method with an account through the [Update a payment method](https://developer.zuora.com/v1-api-reference/api/operation/PUT_PaymentMethod/) operation. type: string cardHolderInfo: $ref: '#/components/schemas/CreateApplePayPaymentMethodCardholderInfo' integrationType: description: | Field to identify the token decryption type. **Note:** The only value at this time is `ApplePay`. type: string invoiceId: description: | The id of invoice this payment will apply to. **Note:** When `processPayment` is `true`, this field is required. Only one invoice can be paid; for scenarios where you want to pay for multiple invoices, set `processPayment` to `false` and call payment API separately. type: string merchantID: description: | The Merchant ID that was configured for use with Apple Pay in the Apple iOS Developer Center. type: string mitConsentAgreementSrc: description: | This field is only available for the following gateway integrations to create stored credential profiles within payment methods: - Chase Paymentech Orbital Gateway - CyberSource Payment API v2.0 - Stripe v2 - Vantiv (Now Worldpay) - Worldpay 1.4 Specify how the consent agreement has been established with the customer. The allowed value is `External`. It is required if the `mitProfileAction` field is specified. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field. enum: - External type: string mitProfileAction: description: | This field is only available for the following gateway integrations to create stored credential profiles within payment methods: - Chase Paymentech Orbital Gateway - CyberSource Payment API v2.0 - Stripe v2 - Vantiv (Now Worldpay) - Worldpay 1.4 Specify either of the following values in this field: - `Activate` - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field. enum: - Activate - Persist type: string mitProfileType: description: | This field is only available for the following gateway integrations to create stored credential profiles within payment methods: - Chase Paymentech Orbital Gateway - CyberSource Payment API v2.0 - Stripe v2 - Vantiv (Now Worldpay) - Worldpay 1.4 This field indicates the type of the stored credential profile to process recurring or unsecheduled transactions. It is required if the `mitProfileAction` field is specified. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field. enum: - Recurring - Unscheduled type: string paymentGateway: description: | The label name of the gateway instance configured in Zuora that will be used for payment method validation and payment processing. - When `processPayment` is `true`, this `paymentGateway` field is required. - When `processPayment` is `false` or is not provided, the specified gateway instance will be used for payment method validation. Specify a valid gateway instance and it must support the Apple Pay payment method. If not specified, the default gateway of your Zuora customer account will be used. type: string paymentToken: description: | The payload with the Apple Pay token or payment data. type: object processPayment: description: | A boolean flag to control whether a payment should be processed after creating payment method. The payment amount will be equivalent to the amount the merchant supplied in the ApplePay session. Default is false. If this field is set to `true`, you must specify the `paymentGateway` field with the payment gateway instance name. If this field is set to `false`: - You must select the **Verify new credit card** check box on the gateway instance settings page. Otherwise, the cryptogram will not be sent to the gateway. - A separate subscribe or payment API call is required after this payment method creation call. type: boolean required: - integrationType - merchantID - paymentToken type: object POSTPaymentMethodResponseDecryption: properties: amount: description: | The payment amount contained within the encrypted token. type: string paymentId: description: | The ID of newly processed payment, type: string paymentMethodId: description: | ID of the newly-created payment method. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object CreateApplePayPaymentMethodCardholderInfo: description: | The container for the cardholder information. The cardholder name is required for credit card validation. It is strongly recommended to specify the nested `cardHolderName` field in this container. For more information, see `cardHolderName`. The required cardholder address fields vary by gateway. It is strongly recommended to review the gateway's documentation for the most accurate and up-to-date information. properties: addressLine1: description: | The first address line. maxLength: 255 type: string addressLine2: description: | The second address line. maxLength: 255 type: string cardHolderName: description: | The cardholder's full name as it appears on the card. The cardholder name information is required for credit card validation. Zuora retrieves the cardholder name using the following priority: 1. This `cardHolderName` field if available. 2. The cardholder name in the `paymentToken` field if available. 3. The full bill-to-contact name of the customer account. It is strongly recommended to provide the cardholder name through this field. maxLength: 50 type: string city: description: | The city. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. maxLength: 40 type: string country: description: | The country, which must be a valid country name or abbreviation. It is recommended to provide the city and country information when creating a payment method. The information will be used to process payments. If the information is not provided during payment method creation, the city and country data will be missing during payment processing. type: string email: description: | The cardholder's email address. maxLength: 80 type: string phone: description: | The phone number. maxLength: 40 type: string state: description: | The state, which must be a valid subregion (state or province) name or code. For more information, see View subregions of a specific country or region. type: string zipCode: description: | The zip code. maxLength: 20 type: string title: CardHolderInfo type: object GETPaymentMethodResponse: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/GETPMAccountHolderInfo' accountVerificationService: description: | Displays the name of the service provider. For example, Plaid. type: string accountVerificationStatus: description: | Displays the status of the account. **Note:** - `Active` - Access token is active. - `Expired` - Access token has expired and must be linked again. - `Expiring` - Access token will expire in few days(7 days for Plaid) and must be linked again - `Inactive` - The end customer has revoked the account permission. The end customer can login again and select the same method for the access token to be linked again. enum: - Active - Expired - Expiring - Inactive type: string bankIdentificationNumber: description: | The first six or eight digits of the payment method's number, such as the credit card number or account number. Banks use this number to identify a payment method. type: string createdBy: description: ID of the user who created this payment method. type: string createdOn: description: | The date and time when the payment method was created, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string creditCardMaskNumber: description: | The masked credit card number, such as: ``` *********1112 ``` type: string creditCardType: description: | The type of the credit card or debit card. Possible values include `Visa`, `MasterCard`, `AmericanExpress`, `Discover`, `JCB`, and `Diners`. For more information about credit card types supported by different payment gateways, see [Supported Payment Gateways](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways). **Note:** This field is only returned for the Credit Card and Debit Card payment types. type: string deviceSessionId: description: | The session ID of the user when the `PaymentMethod` was created or updated. type: string existingMandate: description: | Indicates whether the mandate is an existing mandate. enum: - 'Yes' - 'No' type: string id: description: | The payment method ID. type: string ipAddress: description: | The IP address of the user when the payment method was created or updated. type: string isDefault: description: | Indicates whether this payment method is the default payment method for the account. type: boolean lastFailedSaleTransactionDate: description: | The date of the last failed attempt to collect payment with this payment method. format: date-time type: string lastTransaction: description: ID of the last transaction of this payment method. type: string lastTransactionTime: description: The time when the last transaction of this payment method happened. format: date-time type: string mandateInfo: $ref: '#/components/schemas/POSTPMMandateInfo' maxConsecutivePaymentFailures: description: | The number of allowable consecutive failures Zuora attempts with the payment method before stopping. type: integer numConsecutiveFailures: description: | The number of consecutive failed payments for this payment method. It is reset to `0` upon successful payment. format: int32 type: integer paymentRetryWindow: description: | The retry interval setting, which prevents making a payment attempt if the last failed attempt was within the last specified number of hours. type: integer secondTokenId: description: | A gateway unique identifier that replaces sensitive payment method data. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. type: string status: description: | The status of the payment method. enum: - Active - Closed - Scrubbed type: string tokenId: description: | A gateway unique identifier that replaces sensitive payment method data or represents a gateway's unique customer profile. **Note:** This field is only returned for the Credit Card Reference Transaction payment type. type: string totalNumberOfErrorPayments: description: | The number of error payments that used this payment method. format: int32 type: integer totalNumberOfProcessedPayments: description: | The number of successful payments that used this payment method. format: int32 type: integer type: description: | The type of the payment method. type: string enum: - CreditCard - CreditCardReferenceTransaction - ACH - SEPA - Betalingsservice - Autogiro - Bacs - Becs - Becsnz - PAD - PayPalCP - PayPalEC - PayPalNativeEC - PayPalAdaptive - AdyenApplePay - AdyenGooglePay - GooglePay updatedBy: description: ID of the user who made the last update to this payment method. type: string updatedOn: description: | The last date and time when the payment method was updated, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string useDefaultRetryRule: description: | Indicates whether this payment method uses the default retry rules configured in the Zuora Payments settings. type: boolean cardBinInfo: description: | The BIN information of a card payment method. properties: brand: description: | The card brand, such as `Visa` and `MasterCard`. type: string cardClass: description: | The type of the card. type: string enum: - ChargeCard - Credit - Debit - DeferredDebit - Prepaid productType: description: | The product type of the card. type: string enum: - Commercial_or_Corporate_Card - Consumer_Card issuer: description: | The issuer bank of the card, such as `JPMORGAN CHASE BANK N.A.`. type: string issuingCountryCode: description: | The issuing country code of the card, such as `US`. type: string type: object type: object - $ref: '#/components/schemas/PaymentMethodObjectCustomFields' - $ref: '#/components/schemas/GETPaymentMethodResponseBankTransfer' - $ref: '#/components/schemas/GETPaymentMethodResponseACH' - $ref: '#/components/schemas/GETPaymentMethodResponseCreditCard' - $ref: '#/components/schemas/GETPaymentMethodResponsePayPal' - $ref: '#/components/schemas/GETPaymentMethodResponseGooglePay' - $ref: '#/components/schemas/GETPaymentMethodResponseApplePay' GETPMAccountHolderInfo: description: | The account holder information. properties: accountHolderName: description: | The full name of the account holder. type: string addressLine1: description: | The first line of the address for the account holder. type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. type: string country: description: | The country where the account holder stays. When creating a payment method through a translated UI or Payment Page, a country name in a translated language might be selected. Regardless of the country texts selected when creating the payment method, only the supported country name returns in this field. For a complete list of supported country names, see View countries or regions. Internationalization is not supported for the API field value. type: string email: description: | The email address of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string title: accountHolderInfo type: object POSTPMMandateInfo: description: | The mandate information for the Credit Card, Apple Pay, Google Pay, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. The following mandate fields are common to all supported payment methods: * `mandateId` * `mandateReason` * `mandateStatus` The following mandate fields are specific to the ACH and Bank Transfer payment methods: * `mandateReceivedStatus` * `existingMandateStatus` * `mandateCreationDate` * `mandateUpdateDate` The following mandate fields are specific to the Credit Card, Apple Pay, and Google Pay payment methods: * `mitTransactionId` * `mitProfileAgreedOn` * `mitConsentAgreementRef` * `mitConsentAgreementSrc` * `mitProfileType` * `mitProfileAction` properties: existingMandateStatus: description: | Indicates whether the mandate is an existing mandate. enum: - 'Yes' - 'No' type: string mandateCreationDate: description: | The date on which the mandate was created. format: date type: string mandateId: description: | The mandate ID. type: string mandateReason: description: | The reason of the mandate from the gateway side. type: string mandateReceivedStatus: description: | Indicates whether the mandate is received from the gateway enum: - 'Yes' - 'No' type: string mandateStatus: description: | The status of the mandate from the gateway side. type: string mandateUpdateDate: description: | The date on which the mandate was updated. format: date type: string mitConsentAgreementRef: description: | Reference for the consent agreement that you have established with the customer. type: string mitConsentAgreementSrc: description: | Required if you set the `mitProfileAction` field. Specifies how the consent agreement has been established with the customer. The allowed value is `External`. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `External` set to this field. enum: - External type: string mitProfileAction: description: | Specifies how Zuora creates and activates the stored credential profile. Only applicable if you set the `status` field to `Active`. - `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. If you do not specify this field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Activate` set to this field. enum: - Activate - Persist type: string mitProfileAgreedOn: description: | The date on which the stored credential profile is agreed. The date format is `yyyy-mm-dd`. format: date type: string mitProfileType: description: | Indicates the type of the stored credential profile. If you do not specify the `mitProfileAction` field, Zuora will automatically create a stored credential profile for the payment method, with the default value `Recurring` set to this field. type: string mitTransactionId: description: | Specifies the ID of the transaction. Only applicable if you set the `mitProfileAction` field to `Persist`. maxLength: 128 type: string title: mandateInfo type: object GETPaymentMethodResponseBankTransfer: properties: IBAN: description: | The International Bank Account Number used to create the SEPA payment method. The value is masked. type: string accountNumber: description: | The number of the customer's bank account and it is masked. type: string bankCode: description: | The sort code or number that identifies the bank. This is also known as the sort code. type: string bankTransferType: description: | The type of the Bank Transfer payment method. For example, `SEPA`. type: string branchCode: description: | The branch code of the bank used for Direct Debit. type: string businessIdentificationCode: description: | The BIC code used for SEPA. The value is masked. type: string identityNumber: description: | The identity number of the account holder or the cardholder. type: string type: object GETPaymentMethodResponseACH: properties: bankABACode: description: | The nine-digit routing number or ABA number used by banks. This field is only required if the `type` field is set to `ACH`. type: string bankAccountName: description: | The name of the account holder, which can be either a person or a company. This field is only required if the `type` field is set to `ACH`. type: string bankAccountNumber: description: | The bank account number associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. type: string bankAccountType: description: | The type of bank account associated with the ACH payment. This field is only required if the `type` field is set to `ACH`. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify any of the allowed values as a dummy value, `Checking` preferably. enum: - BusinessChecking - Checking - Saving type: string bankName: description: | The name of the bank where the ACH payment account is held. This field is only required if the `type` field is set to `ACH`. When creating an ACH payment method on Adyen, this field is required by Zuora but it is not required by Adyen. To create the ACH payment method successfully, specify a real value for this field if you can. If it is not possible to get the real value for it, specify a dummy value. type: string type: object GETPaymentMethodResponseCreditCard: properties: cardNumber: description: | The masked credit card number. When `cardNumber` is `null`, the following fields will not be returned: - `expirationMonth` - `expirationYear` - `accountHolderInfo` type: string expirationMonth: description: | One or two digits expiration month (1-12). type: integer expirationYear: description: | Four-digit expiration year. type: integer securityCode: description: | The CVV or CVV2 security code for the credit card or debit card. Only required if changing expirationMonth, expirationYear, or cardHolderName. To ensure PCI compliance, this value isn''t stored and can''t be queried. type: string type: object GETPaymentMethodResponsePayPal: properties: BAID: description: | ID of a PayPal billing agreement. For example, I-1TJ3GAGG82Y9. type: string email: description: | Email address associated with the PayPal payment method. type: string preapprovalKey: description: | The PayPal preapproval key. type: string type: object GETPaymentMethodResponseGooglePay: properties: googleBIN: description: | This field is only available for Google Pay payment methods. type: string googleCardNumber: description: | This field is only available for Google Pay payment methods. type: string googleCardType: description: | This field is only available for Google Pay payment methods. For Google Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. type: string googleExpiryDate: description: | This field is only available for Google Pay payment methods. type: string googleGatewayToken: description: | This field is only available for Google Pay payment methods. type: string type: object GETPaymentMethodResponseApplePay: properties: appleBIN: description: | This field is only available for Apple Pay payment methods. type: string appleCardNumber: description: | This field is only available for Apple Pay payment methods. type: string appleCardType: description: | This field is only available for Apple Pay payment methods. For Apple Pay payment methods on Adyen, the first 100 characters of [paymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant) returned from Adyen are stored in this field. type: string appleExpiryDate: description: | This field is only available for Apple Pay payment methods. type: string appleGatewayToken: description: | This field is only available for Apple Pay payment methods. type: string type: object PUTPaymentMethodRequest: allOf: - properties: accountHolderInfo: $ref: '#/components/schemas/PUTPMAccountHolderInfo' accountKey: description: | The customer account ID such as `2x92c0f859b0480f0159d3a4a6ee5bb6` or the customer account number such as `A02855638`. **Note:** You can use this field to associate an orphan payment method with a customer account. If a payment method is already associated with a customer account, you cannot change the associated payment method through this operation. You cannot remove the previous account ID and leave this field empty, either. type: string authGateway: description: | Specifies the ID of the payment gateway that Zuora will use to authorize the payments that are made with the payment method. This field is not supported in updating Credit Card Reference Transaction payment methods. If Payment Gateway Routing is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to update the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to update the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to update the payment. type: string currencyCode: description: | The currency used for payment method authorization. type: string gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. This field is not supported in updating Credit Card Reference Transaction payment methods. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object ipAddress: description: | The IPv4 or IPv6 information of the user when the payment method is created or updated. Some gateways use this field for fraud prevention. If this field is passed to Zuora, Zuora directly passes it to gateways. If the IP address length is beyond 45 characters, a validation error occurs. For validating SEPA payment methods on Stripe v2, this field is required. type: string mandateInfo: description: | The mandate information for the Credit Card, Credit Card Reference Transaction, ACH, or Bank Transfer payment method. properties: mandateId: description: | The mandate ID. maxLength: 36 type: string mandateReason: description: | The reason of the mandate from the gateway side. maxLength: 64 type: string mandateStatus: description: | The status of the mandate from the gateway side. maxLength: 64 type: string type: object processingOptions: description: | The container for payment method processing options. properties: checkDuplicated: description: | Indicates whether to perform a duplication check when you create a payment method of the following types: - Credit Card - ACH - Bank Transfer The default value is `false`. With this field set to `true`, Zuora will check the active and closed payment methods associated with the same billing account to ensure that no duplicate payment methods are created. For more information, see Duplication check on payment methods. type: boolean type: object maxConsecutivePaymentFailures: description: | The maximum number of payment failures allowed for this payment method. This field is only applicable if `useDefaultRetryRule` is set to `false`. type: integer minimum: 1 maximum: 100 nullable: true paymentRetryWindow: description: | The retry interval in hours. This field is only applicable if `useDefaultRetryRule` is set to `false`. type: integer minimum: 1 maximum: 1000 nullable: true useDefaultRetryRule: description: | Specifies whether to apply the default retry rule configured for your tenant in the Zuora Payments settings: - To use the default retry rule, specify `true`. - To use the custom retry rule specific to this payment method, specify `false`. type: boolean type: object - $ref: '#/components/schemas/PUTPMCreditCardInfo' - $ref: '#/components/schemas/PUTPaymentMethodObjectCustomFields' example: securityCode: '331' PUTPaymentMethodResponse: properties: id: description: | ID of the updated payment method. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object PUTPMAccountHolderInfo: description: | The account holder information. This field is not supported in updating Credit Card Reference Transaction payment methods. properties: addressLine1: description: | The first line of the address for the account holder. This field is required for SEPA Direct Debit payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). type: string addressLine2: description: | The second line of the address for the account holder. type: string city: description: | The city where the account holder stays. type: string country: description: | The country where the account holder stays. This field is required for SEPA payment methods on Stripe v2 for [certain countries](https://stripe.com/docs/payments/sepa-debit/set-up-payment?platform=web#web-submit-payment-method). type: string email: description: | The email address of the account holder. type: string phone: description: | The phone number of the account holder. type: string state: description: | The state where the account holder stays. type: string zipCode: description: | The zip code for the address of the account holder. type: string title: accountHolderInfo type: object PUTPMCreditCardInfo: properties: expirationMonth: description: | One or two digits expiration month (1-12). type: integer expirationYear: description: | Four-digit expiration year. type: integer securityCode: description: | Optional. It is the CVV or CVV2 security code specific for the credit card or debit card. To ensure PCI compliance, this value is not stored and cannot be queried. If securityCode code is not passed in the request payload, this operation only updates related fields in the payload. It does not validate the payment method through the gateway. If securityCode is passed in the request payload, this operation retrieves the credit card information from payload and validates them through the gateway. type: string type: object PUTPaymentMethodObjectCustomFields: additionalProperties: description: | Custom fields of the payment method. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. Custom fields are not supported in updating Credit Card Reference Transaction payment methods. description: | Container for custom fields of a payment method object. title: paymentMethodFieldsCustom type: object PUTVerifyPaymentMethodType: example: securityCode: '737' properties: currencyCode: description: | The currency used for payment method authorization. type: string gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object paymentGatewayName: description: | The name of the payment gateway instance. If Payment Gateway Routing is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to verify the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to verify the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to verify the payment. type: string securityCode: description: | The CVV or CVV2 security code for the credit card or debit card. To ensure PCI compliance, the value of this field is not stored and cannot be queried. type: string type: object PUTVerifyPaymentMethodResponseType: properties: paymentMethodId: description: | The ID of the verified payment method. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GetBankAccountBalanceResponse: properties: success: description: | Indicates whether this call succeeds. type: boolean currency: description: | The currency of the account balance. type: string availableBalance: description: | The amount of funds available to be withdrawn from the account. For more information, see Plaid's documentation. type: number format: double currentBalance: description: | The total amount of funds in the account, which does not take pending transactions into account. For more information, see Plaid's documentation. type: number format: double type: object GetStoredCredentialProfilesResponse: properties: profiles: description: | Container for stored credential profiles. items: properties: activatedOn: description: | The date when the stored credential profile was activated (if applicable). format: date-time type: string agreedOn: description: | The date when the stored credential profile was created. format: date-time type: string brand: description: | The stored credential transaction framework. For example, Visa. type: string cancelledOn: description: | The date when the stored credential profile was cancelled (if applicable). format: date-time type: string consentAgreementRef: description: | Your reference for the consent agreement that you have established with the customer. maxLength: 128 type: string consentAgreementSrc: enum: - External type: string expiredOn: description: | The date when the stored credential profile was expired (if applicable). format: date-time type: string number: description: | The number that identifies the stored credential profile within the payment method. type: integer paymentMethodId: description: | ID of the payment method. type: string status: description: | The status of the stored credential profile. * `Agreed` - The stored credential profile has not been validated via an authorization transaction with the payment gateway. * `Active` - The stored credential profile has been validated via an authorization transaction with the payment gateway. * `Cancelled` - The stored credentials are no longer valid, per a customer request. Zuora cannot use the stored credentials in transactions. * `Expired` - The stored credentials are no longer valid, per an expiration policy in the stored credential transaction framework. Zuora cannot use the stored credentials in transactions. enum: - Agreed - Active - Cancelled - Expired type: string type: enum: - Recurring - Unscheduled type: string type: array success: type: boolean type: object CreateStoredCredentialProfileRequest: example: authGateway: 4028905f5702783601570291e14c0015 consentAgreementRef: ACCT1338AgreementV1.pdf consentAgreementSrc: External status: Active type: Recurring properties: action: description: | Specifies how Zuora activates the stored credential profile. Only applicable if you set the `status` field to `Active`. - `Activate` (default) - Use this value if you are creating the stored credential profile after receiving the customer's consent. Zuora will create the stored credential profile then send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. If the CIT succeeds, the status of the stored credential profile will be `Active`. If the CIT does not succeed, Zuora will not create a stored credential profile. If the payment gateway does not support the stored credential transaction framework, the status of the stored credential profile will be `Agreed`. - `Persist` - Use this value if the stored credential profile represents a stored credential profile in an external system. The status of the payment method's stored credential profile will be `Active`. enum: - Activate - Persist type: string agreedOn: description: | The date on which the profile is agreed. The date format is `yyyy-mm-dd`. format: date type: string authGateway: description: | Specifies the ID of the payment gateway that Zuora will use when activating the stored credential profile. type: string cardSecurityCode: description: | The security code of the credit card. type: string consentAgreementRef: description: | Specifies your reference for the consent agreement that you have established with the customer. maxLength: 128 type: string consentAgreementSrc: description: | Specifies how the consent agreement has been established with the customer. The allowed value is `External`. enum: - External type: string networkTransactionId: description: | The ID of a network transaction. Only applicable if you set the `action` field to `Persist`. maxLength: 128 type: string status: description: | Specifies the status of the stored credential profile. - `Active` - Use this value if you are creating the stored credential profile after receiving the customer's consent, or if the stored credential profile represents a stored credential profile in an external system. You can use the `action` field to specify how Zuora activates the stored credential profile. - `Agreed` - Use this value if you are migrating the payment method to the stored credential transaction framework. In this case, Zuora will not send a cardholder-initiated transaction (CIT) to the payment gateway to validate the stored credential profile. enum: - Agreed - Active type: string type: description: | Indicates the type of the stored credential profile to process recurring or unsecheduled transactions. enum: - Recurring - Unscheduled type: string required: - status - type - consentAgreementSrc type: object ModifiedStoredCredentialProfileResponse: properties: number: description: | The number that identifies the stored credential profile within the payment method. type: integer paymentMethodId: description: | ID of the payment method. type: string success: type: boolean type: object GETListApplePayDomainsResponse: properties: domains: description: | Container for domains that are already registered with Apple Pay. items: properties: createdBy: description: | The ID of the user who created this domain. type: string createdOn: description: | The date and time when the domain was created, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string domainName: description: | The name of the domain registered with Apple Pay, such as `testapplepay.zuora.com`. type: string domainVerified: description: | Indicates whether the domain registration is successfully verified. type: boolean id: description: | The ID of the domain, such as `402881a38924ff1001892502da090021`. type: string updatedBy: description: | The ID of the user who made the last update to this domain. type: string updatedOn: description: | The last date and time when the domain was updated, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string type: array success: description: | Indicates whether this call succeeds. type: boolean type: object POSTRegisterApplePayDomainRequest: example: domainName: testapplepay.zuora.com properties: domainName: description: | The name of the domain to be registered with Apple Pay, such as `testapplepay.zuora.com`. type: string required: - domainName type: object POSTRegisterApplePayDomainResponse: properties: domainName: description: | The name of the domain registered with Apple Pay, such as `testapplepay.zuora.com`. type: string domainVerified: description: | Indicates whether the domain registration is successfully verified. type: boolean id: description: | The ID of the domain, such as `402881a38924ff1001892502da090021`. type: string success: description: | Indicates whether this call succeeds. type: boolean type: object DELETEUnresigerApplePayDomainResponse: properties: success: description: Indicates whether this call succeeds. type: boolean type: object POSTCreatePaymentSessionRequest: example: currency: USD accountId: 402882e98d3a964b018d3a9c99ef0167 processPayment: true storePaymentMethod: true paymentGateway: 402883827d097a28017d09b41f690261 invoices: - invoiceNumber: INV00001274 - invoiceNumber: INV00001278 amount: 100 properties: accountId: description: | The ID of the customer account in Zuora that is associated with this payment method. This field is required when `processPayment` is set to `true`. It is optional when `processPayment` is set to `false`. type: string amount: description: | If `processPayment` is `true`, it is the amount of the payment. If `invoices` is specified, the value of `amount` must be the current total balances of the specified invoices. If `processPayment` is `false`, it is the authorization amount for the payment method. type: number authAmount: description: | The authorization amount for the payment method. Specify a value greater than 0. **Note:** This field is being deprecated. It is recommended to use the `amount` field. type: number currency: description: | The currency of the payment in the format of the three-character ISO currency code. type: string gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the overview topic of each gateway integration in Zuora Knowledge Center. Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. type: object title: GatewayOptions additionalProperties: type: string description: | The gateway options specification consists of key-value pairs: - Field name: The name of a gateway-specific parameter. - Field value: The value of the gateway-specific parameter. paymentGateway: description: | The ID of the payment gateway instance configured in Zuora that will process the payment, such as `e884322ab8c711edab030242ac120004`. If Payment Gateway Routing is enabled: - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. If Payment Gateway Routing is disabled: - If this field is not specified, the default payment gateway will be used to process the payment. The default gateway of the customer account takes precedence over the default gateway of the tenant. - If this field is specified, the specified gateway will be used to process the payment. type: string processPayment: description: | Indicate whether a payment should be processed after creating the payment method. If this field is set to `true`, you must specify either the `amount` field or the `invoices` and `amount` fields. If this field is set to `false`, you must specify the `amount` field. type: boolean storePaymentMethod: description: | `true` indicates that the payment method will be stored in Zuora and will be used in subsequent recurring payments. `false` indicates that the payment method will not be stored in Zuora. End-customers need to be brought back on-session to authenticate the payment. type: boolean default: true invoices: description: | The array of invoices that a payment applies to. All the specified invoices will be fully paid. The value of the `amount` field must be the current total balances of the specified invoices. Here is an example: ``` "invoices": [ { "invoiceNumber": "INV00001274" }, { "invoiceNumber": "INV00001278" } ] ``` items: type: object properties: invoiceNumber: description: | The invoice number, such as `INV0000001`. type: string type: array required: - currency - processPayment - amount type: object POSTCreatePaymentSessionResponse: properties: token: description: | The token for the payment session data. type: string type: object PaymentCollectionResponseType: properties: nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string payments: description: | Container for payments. items: $ref: '#/components/schemas/GETARPaymentTypewithSuccess' type: array success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETARPaymentTypewithSuccess: allOf: - properties: accountId: description: | The ID of the customer account that the payment is for. type: string accountNumber: description: | The number of the customer account that the payment is for. type: string amount: description: | The total amount of the payment. format: double type: number appliedAmount: description: | The applied amount of the payment. format: double type: number authTransactionId: description: | The authorization transaction ID from the payment gateway. type: string nullable: true bankIdentificationNumber: description: | The first six or eight digits of the credit card or debit card used for the payment, when applicable. type: string nullable: true cancelledOn: description: | The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the payment. type: string createdById: description: | The ID of the Zuora user who created the payment part. type: string createdDate: description: | The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditBalanceAmount: description: | The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature. format: double type: number currency: description: | When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency. type: string effectiveDate: description: | The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string financeInformation: description: | Container for the finance information related to the payment. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string nullable: true bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string nullable: true transferredToAccounting: description: | Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string nullable: true unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string nullable: true type: object gatewayId: description: | The ID of the gateway instance that processes the payment. type: string nullable: true gatewayOrderId: description: | A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. type: string nullable: true gatewayReconciliationReason: description: | The reason of gateway reconciliation. type: string nullable: true gatewayReconciliationStatus: description: | The status of gateway reconciliation. type: string nullable: true gatewayResponse: description: | The message returned from the payment gateway for the payment. This message is gateway-dependent. type: string nullable: true gatewayResponseCode: description: | The code returned from the payment gateway for the payment. This code is gateway-dependent. type: string nullable: true gatewayState: description: | The status of the payment in the gateway; use for reconciliation. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The unique ID of the payment. For example, 4028905f5a87c0ff015a87eb6b75007f. type: string markedForSubmissionOn: description: | The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true number: description: | The unique identification number of the payment. For example, P-00000001. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentGatewayNumber: description: | The natural key for the payment gateway. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. type: string nullable: true paymentOption: description: | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported. `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item. items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. type: string payoutId: description: | The payout ID of the payment from the gateway side. type: string nullable: true prepayment: description: | Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. type: boolean referenceId: description: | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true refundAmount: description: | The amount of the payment that is refunded. format: double type: number secondPaymentReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true settledOn: description: | The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string nullable: true softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true standalone: default: false description: | This field is only available if the support for standalone payment is enabled. The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred. The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora. type: boolean status: description: | The status of the payment. enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string submittedOn: description: | The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true type: description: | The type of the payment. enum: - External - Electronic type: string unappliedAmount: description: | The unapplied amount of the payment. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the payment. type: string updatedDate: description: | The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' title: payments PaymentSchedulePaymentOptionFields: properties: detail: description: | The field used to pass the transactional payment data to the gateway side in the key-value format. properties: key: description: | The name of the field. type: string value: description: | The value of the field. type: string type: object type: description: | The type of the payment option. Currently, only `GatewayOptions` is supported for specifying Gateway Options fields supported by a payment gateway. type: string title: paymentOption type: object PaymentObjectNSFields: description: | Container for Payment fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). properties: IntegrationId__NS: description: | ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string IntegrationStatus__NS: description: | Status of the payment's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Origin__NS: description: | Origin of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string SyncDate__NS: description: | Date when the payment was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string Transaction__NS: description: | Related transaction in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265). maxLength: 255 type: string title: paymentFieldsNS type: object PaymentObjectCustomFields: additionalProperties: description: | Custom fields of the Payment object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Payment object. title: paymentFieldsCustom type: object CreatePaymentType: allOf: - properties: accountId: description: | The ID of the customer account that the payment is created for. type: string accountNumber: description: | The number of the customer account that the payment is created for, such as `A00000001`. You can specify either `accountNumber` or `accountId` for a customer account. If both of them are specified, they must refer to the same customer account. type: string amount: description: | The total amount of the payment. format: double type: number authTransactionId: description: | The authorization transaction ID from the payment gateway. Use this field for electronic payments, such as credit cards. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field. The following payment gateways support this field: - Adyen Integration v2.0 - CyberSource 1.28 - CyberSource 1.97 - CyberSource 2.0 - Chase Paymentech Orbital - Ingenico ePayments - SlimPay - Stripe v2 - Verifi Global Payment Gateway - WePay Payment Gateway Integration maxLength: 50 type: string comment: description: | Additional information related to the payment. maxLength: 255 minLength: 0 type: string currency: description: | When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. But if you have the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature enabled, you can have a different payment currency. When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency. type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item or Reporting currency item or both). **Note**: - This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. - Payment, PaymentApplication, and PaymentApplicationItem will utilize the provided custom Fx rate to convert amounts from the transactional currency to the home currency. items: $ref: '#/components/schemas/PaymentWithCustomRatesType' maxItems: 2 type: array debitMemos: description: | Container for debit memos. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationCreateRequestType' type: array effectiveDate: description: | The date when the payment takes effect, in `yyyy-mm-dd` format. **Note:** - This field is required for only electronic payments. It's an optional field for external payments. - When specified, this field must be set to the date of today. - When applying or transferring payments, this field must be later than or equal to the maximum effective date of the payment. format: date type: string financeInformation: description: | Container for the finance information related to the payment. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. maxLength: 100 minLength: 0 type: string transferredToAccounting: description: | Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. maxLength: 100 minLength: 0 type: string type: object gatewayId: description: | The ID of the gateway instance that processes the payment. The ID must be a valid gateway instance ID and this gateway must support the specific payment method. - If Payment Gateway Routing is enabled, when creating electronic payments, this field is optional. - If this field is not specified, gateway routing rules will be invoked. - If this field is specified, the specified gateway will be used to process the payment. - If Payment Gateway Routing is disabled, when creating electronic payments, this field is required. - When creating external payments, this field is optional. Use the same gateway instance if both `paymentGatewayNumber` and `gatewayId` are sent in the request. type: string gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. properties: key: description: | The name of a gateway-specific parameter. maxLength: 255 type: string value: description: | The value of the gateway-specific parameter. maxLength: 255 type: string type: object gatewayOrderId: description: | A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. Gateways check duplicates on the gateway order ID to ensure that the merchant do not accidentally enter the same transaction twice. This ID can also be used to do reconciliation and tie the payment to a natural key in external systems. The source of this ID varies by merchant. Some merchants use their shopping cart order IDs, and others use something different. Merchants use this ID to track transactions in their eCommerce systems. When you create a payment for capturing the authorized funds, it is highly recommended to pass in the gatewayOrderId that you used when authorizing the funds by using the [Create authorization](https://www.zuora.com/developer/api-references/api/operation/POST_CreateAuthorization) operation, together with the `authTransactionId` field. maxLength: 50 type: string invoices: description: | Container for invoices. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/PaymentInvoiceApplicationCreateRequestType' type: array mitTransactionSource: description: | Payment transaction source used to differentiate the transaction source in Stored Credential Transaction framework. - `C_Unscheduled`: Cardholder-initiated transaction (CIT) that does not occur on scheduled or regularly occurring dates. - `M_Recurring`: Merchant-initiated transaction (MIT) that occurs at regular intervals. - `M_Unscheduled`: Merchant-initiated transaction (MIT) that does not occur on scheduled or regularly occurring dates. - `M_MOTO`: Mail Order Telephone Order (MOTO) payment transaction. This option is only available for credit card payments on Stripe v2. See [Overview of Stripe payment gateway integration](https://knowledgecenter.zuora.com/Zuora_Collect/Payment_gateway_integrations/Supported_payment_gateways/Stripe_Payment_Gateway/A_Overview_of_Stripe_payment_gateway_integration) for more information. enum: - C_Unscheduled - M_Recurring - M_Unscheduled - M_MOTO type: string paymentGatewayNumber: description: | The natural key for the payment gateway. Use the same gateway instance if both `paymentGatewayNumber` and `gatewayId` are sent in the request. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. If no payment method ID is specified in the request body, the default payment method for the customer account is used automatically. If the default payment method is different from the type of payments that you want to create, an error occurs. type: string paymentMethodType: default: null description: | The type of the payment method that the customer used to make the payment. Specify this value when you are creating an external payment method. If both `paymentMethodType` and `paymentMethodId` are specified, only the `paymentMethodId` value is used to create the payment. type: string paymentOption: description: | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported. Here is an example: ``` "paymentOption": [ { "type": "GatewayOptions", "detail": { "SecCode":"WEB" } } ] ``` `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item. You can use this field or the `gatewayOptions` field to pass the Gateway Options fields supported by a payment gateway. However, the Gateway Options fields passed through the `paymentOption` field will be stored in the Payment Option object and can be easily retrieved. items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: description: The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. type: string prepayment: description: | Indicates whether the payment will be used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. type: boolean referenceId: description: | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string softDescriptor: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 35 type: string softDescriptorPhone: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 20 type: string standalone: default: false description: | This field is only available if support for standalone payments is enabled. Specify `true` to create a standalone payment that will be processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. When `standalone` is set to `true`: - `accountId`, `amount`, `currency`, and `type` are required. - `type` must be `Electronic`. - `currency` of the payment can be different from the payment currency in the customer account settings. - The amount will not be summed up into the account balance and key metrics regardless of the payment currency. - No settlement data will be created. - Either the applied amount or the unapplied amount of the payment is zero. - The standalone payment cannot be applied, unapplied, or transferred. Specify `false` to create an ordinary payment that will be created, processed, and settled in Zuora. The `currency` of an ordinary payment must be the same as the currency in the customer account settings. type: boolean type: description: | The type of the payment. **Note**: If you specify the type as `Electronic`, you must specify the value for `accountId` or `accountNumber`. enum: - External - Electronic type: string required: - amount - currency - type type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' example: accountId: 8a90b4488e7d5c0f018e7db3892400b2 type: External paymentMethodId: 2c92c8f95e2d6ebb015e325df7a70356 amount: 14.99 currency: USD invoices: - invoiceId: 8a90e5e4914ad4fa01914b25ff2c036e amount: 14.99 GETARPaymentTypeWithPaymentOption: allOf: - properties: accountId: description: | The ID of the customer account that the payment is for. type: string accountNumber: description: | The number of the customer account that the payment is for. type: string amount: description: | The total amount of the payment. format: double type: number appliedAmount: description: | The applied amount of the payment. format: double type: number authTransactionId: description: | The authorization transaction ID from the payment gateway. type: string bankIdentificationNumber: description: | The first six or eight digits of the credit card or debit card used for the payment, when applicable. type: string cancelledOn: description: | The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the payment. type: string nullable: true createdById: description: | The ID of the Zuora user who created the payment. type: string createdDate: description: | The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditBalanceAmount: description: | The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature. format: double type: number currency: description: | When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency. type: string effectiveDate: description: | The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string financeInformation: description: | Container for the finance information related to the payment. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string nullable: true bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string nullable: true transferredToAccounting: description: | Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string nullable: true unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string nullable: true unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string nullable: true type: object gatewayId: description: | The ID of the gateway instance that processes the payment. type: string nullable: true gatewayOrderId: description: | A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. type: string gatewayReconciliationReason: description: | The reason of gateway reconciliation. type: string nullable: true gatewayReconciliationStatus: description: | The status of gateway reconciliation. type: string nullable: true gatewayResponse: description: | The message returned from the payment gateway for the payment. This message is gateway-dependent. type: string nullable: true gatewayResponseCode: description: | The code returned from the payment gateway for the payment. This code is gateway-dependent. type: string gatewayState: description: | The status of the payment in the gateway; use for reconciliation. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f. type: string markedForSubmissionOn: description: | The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string number: description: | The unique identification number of the payment. For example, P-00000001. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentGatewayNumber: description: | The natural key for the payment gateway. type: string nullable: true paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. type: string nullable: true paymentOption: description: | Container for the paymentOption items, which describe the transactional level rules for processing payments. Currently, only the Gateway Options type is supported. `paymentOption` of the payment schedule takes precedence over `paymentOption` of the payment schedule item. items: $ref: '#/components/schemas/PaymentSchedulePaymentOptionFields' type: array paymentScheduleKey: description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. type: string payoutId: description: | The payout ID of the payment from the gateway side. type: string nullable: true prepayment: description: | Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. type: boolean referenceId: description: | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true refundAmount: description: | The amount of the payment that is refunded. format: double type: number secondPaymentReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true settledOn: description: | The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string nullable: true softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true standalone: default: false description: | This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment. The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred. The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora. type: boolean status: description: | The status of the payment. If the Asynchronous Payment Statuses feature is not enabled, possible values are `Draft`, `Processing`, `Processed`, `Error`, `Canceled`, and `Posted`. If the Asynchronous Payment Statuses feature is enabled, when the ACH or Bank Transfer payment is created, it is in a `Pending` status upon successful network communication with the gateway. To transition from a `Pending` status to another status, use one of our Gateway Reconciliation options or cancel the payment. enum: - Draft - Processing - Processed - Error - Canceled - Posted - Pending type: string submittedOn: description: | The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: description: | The type of the payment. enum: - External - Electronic type: string unappliedAmount: description: | The unapplied amount of the payment. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the payment. type: string updatedDate: description: | The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' PaymentWithCustomRatesType: allOf: - properties: currency: description: | The currency code for either Reporting or Home currency. **Note**: This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). type: string customFxRate: description: | The Custom FX conversion rate between Home/Reporting and Transactional currency items. **Note**: This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: decimal type: number rateDate: description: | The date on which a particular currency rate is fixed or obtained on. **Note**: This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). format: date type: string required: - currency - customFxRate type: object title: customRates PaymentDebitMemoApplicationCreateRequestType: properties: amount: description: | The amount of the payment associated with the debit memo. format: double type: number debitMemoId: description: | The unique ID of the debit memo that the payment is created on. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for debit memo items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemCreateRequestType' type: array title: debitMemos type: object PaymentInvoiceApplicationCreateRequestType: properties: amount: description: | The amount of the payment associated with the invoice. This amount must be equal to or lesser than the balance of the invoice. format: double type: number invoiceId: description: | The unique ID of the invoice that the payment is created on. The balance of the invoice specified must not be `0`. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter stage. To gain access to this capability, please create a Zuora support ticket. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for invoice items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemCreateRequestType' type: array title: invoices type: object PaymentInvoiceApplicationItemCreateRequestType: properties: amount: description: | The amount of the payment associated with the specific invoice or taxation item. format: double type: number invoiceItemId: description: | The ID of the specific invoice item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemCreateRequestType: properties: amount: description: | The amount of the payment associated with the specific debit memo or taxation item. format: double type: number debitMemoItemId: description: | The ID of the specific debit memo item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object UpdatePaymentType: allOf: - properties: comment: description: | Comments about the payment. maxLength: 255 minLength: 0 type: string financeInformation: description: | Container for the finance information related to the payment. For a standalone payment, the finance information cannot be updated. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. maxLength: 100 minLength: 0 type: string transferredToAccounting: description: | Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. maxLength: 100 minLength: 0 type: string type: object gatewayState: description: | This field is mainly used for gateway reconciliation. See Electronic payment processing for details. You must have the **Edit Payment Gateway Status** user permission to update this field. enum: - NotSubmitted - Submitted - Settled - FailedToSettle type: string paymentScheduleKey: description: The unique ID or the number of the payment schedule to be linked with the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. type: string referenceId: description: | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. You can only update the reference ID for external payments. maxLength: 100 minLength: 0 type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' example: comment: Details about this payment GETARPaymentType: allOf: - properties: accountId: description: | The ID of the customer account that the payment is for. type: string accountNumber: description: | The number of the customer account that the payment is for. type: string amount: description: | The total amount of the payment. format: double type: number appliedAmount: description: | The applied amount of the payment. format: double type: number authTransactionId: description: | The authorization transaction ID from the payment gateway. type: string bankIdentificationNumber: description: | The first six or eight digits of the credit card or debit card used for the payment, when applicable. type: string cancelledOn: description: | The date and time when the payment was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string comment: description: | Comments about the payment. type: string nullable: true createdById: description: | The ID of the Zuora user who created the payment. type: string createdDate: description: | The date and time when the payment was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditBalanceAmount: description: | The amount that the payment transfers to the credit balance. The value is not `0` only for those payments that come from legacy payment operations performed without the Invoice Settlement feature. format: double type: number currency: description: | When Standalone Payment is not enabled, the `currency` of the payment must be the same as the payment currency defined in the customer account settings through Zuora UI. When Standalone Payment is enabled and `standalone` is `true`, the `currency` of the standalone payment can be different from the payment currency defined in the customer account settings. The amount will not be summed up to the account balance or key metrics regardless of currency. type: string effectiveDate: description: | The date and time when the payment takes effect, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string financeInformation: description: | Container for the finance information related to the payment. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string transferredToAccounting: description: | Whether the payment was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string type: object gatewayId: description: | The ID of the gateway instance that processes the payment. type: string gatewayOrderId: description: | A merchant-specified natural key value that can be passed to the electronic payment gateway when a payment is created. If not specified, the payment number will be passed in instead. type: string gatewayReconciliationReason: description: | The reason of gateway reconciliation. type: string gatewayReconciliationStatus: description: | The status of gateway reconciliation. type: string gatewayResponse: description: | The message returned from the payment gateway for the payment. This message is gateway-dependent. type: string gatewayResponseCode: description: | The code returned from the payment gateway for the payment. This code is gateway-dependent. type: string gatewayState: description: | The status of the payment in the gateway; use for reconciliation. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The unique ID of the created payment. For example, 4028905f5a87c0ff015a87eb6b75007f. type: string markedForSubmissionOn: description: | The date and time when a payment was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string number: description: | The unique identification number of the payment. For example, P-00000001. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentGatewayNumber: description: | The natural key for the payment gateway. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the payment. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot which is a copy of the particular Payment Method used in a transaction. type: string paymentScheduleKey: description: The unique ID or the number of the payment schedule that is linked to the payment. See [Link payments to payment schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Payment_Schedules/Link_payments_with_payment_schedules) for more information. type: string payoutId: description: | The payout ID of the payment from the gateway side. type: string prepayment: description: | Indicates whether the payment is used as a reserved payment. See [Prepaid Cash with Drawdown](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/JA_Advanced_Consumption_Billing/Prepaid_Cash_with_Drawdown) for more information. type: boolean referenceId: description: | The transaction ID returned by the payment gateway. Use this field to reconcile payments between your gateway and Zuora Payments. type: string refundAmount: description: | The amount of the payment that is refunded. format: double type: number secondPaymentReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the payment. Use this field to reconcile payments between your gateway and Zuora Payments. type: string settledOn: description: | The date and time when the payment was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string standalone: default: false description: | This field is only available if the support for standalone payment is enabled. This field is not available for transferring, applying, or unapplying a payment. The value `true` indicates this is a standalone payment that is created and processed in Zuora through Zuora gateway integration but will be settled outside of Zuora. No settlement data will be created. The standalone payment cannot be applied, unapplied, or transferred. The value `false` indicates this is an ordinary payment that is created, processed, and settled in Zuora. type: boolean status: description: | The status of the payment. enum: - Draft - Processing - Processed - Error - Canceled - Posted type: string submittedOn: description: | The date and time when the payment was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: description: | The type of the payment. enum: - External - Electronic type: string unappliedAmount: description: | The unapplied amount of the payment. format: double type: number updatedById: description: | The ID of the Zuora user who last updated the payment. type: string updatedDate: description: | The date and time when the payment was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/PaymentObjectNSFields' - $ref: '#/components/schemas/PaymentObjectCustomFields' ApplyPaymentType: example: invoices: - invoiceId: 8ad097b490c4e5aa0190c9b931817cef amount: 12 properties: debitMemos: description: | Container for debit memos. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationApplyRequestType' type: array effectiveDate: description: | The date when the payment application takes effect, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment. format: date type: string invoices: description: | Container for invoices. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType' type: array type: object PaymentDebitMemoApplicationApplyRequestType: properties: amount: description: | The amount that is applied from the payment to the debit memo. format: double type: number debitMemoId: description: | The unique ID of the debit memo that the payment is applied to. If `debitMemoId` or `debitMemoNumber` is specified, the `writeOff` value can be set to true. This enables writing off a debit memo at the time of refund. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string debitMemoNumber: description: | The number of the debit memo that the payment is applied to. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for debit memo items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemApplyRequestType' type: array required: - amount title: debitMemos type: object PaymentInvoiceApplicationApplyRequestType: properties: amount: description: | The amount that is applied from the payment to the invoice. format: double type: number invoiceId: description: | The unique ID of the invoice that the payment is applied to. If `invoiceId` or `invoiceNumber` is specified, the `writeOff` value can be set to true. This enables writing off a debit memo at the time of refund. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string invoiceNumber: description: | The number of the invoice that the payment is applied to. For example, `INV00000001`. **Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other. - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for invoice items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemApplyRequestType' type: array required: - amount title: invoices type: object PaymentInvoiceApplicationItemApplyRequestType: properties: amount: description: | The amount of the payment that is applied to the specific invoice or taxation item. format: double type: number invoiceItemId: description: | The ID of the specific invoice item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemApplyRequestType: properties: amount: description: | The amount of the payment that is applied to the specific debit memo or taxation item. format: double type: number debitMemoItemId: description: | The ID of the specific debit memo item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object GETPaymentPartsCollectionType: properties: nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string parts: description: | Container for payment parts. items: $ref: '#/components/schemas/GETPaymentPartTypewithSuccess' type: array success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETPaymentPartTypewithSuccess: properties: amount: description: | The amount of the payment part. format: double type: number createdById: description: | The ID of the Zuora user who created the payment part. type: string createdDate: description: | The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoId: description: | The ID of the debit memo associated with the payment part. type: string id: description: | The ID of the payment part. type: string invoiceId: description: | The ID of the invoice associated with the payment part. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string updatedById: description: | The ID of the Zuora user who last updated the payment part. type: string updatedDate: description: | The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string title: parts type: object GETPaymentPartType: properties: amount: description: | The amount of the payment part. format: double type: number createdById: description: | The ID of the Zuora user who created the payment part. type: string createdDate: description: | The date and time when the payment part was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoId: description: | The ID of the debit memo associated with the payment part. type: string id: description: | The ID of the payment part. type: string invoiceId: description: | The ID of the invoice associated with the payment part. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string success: description: Returns `true` if the request was processed successfully. type: boolean updatedById: description: | The ID of the Zuora user who last updated the payment part. type: string updatedDate: description: | The date and time when the payment part was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object GETPaymentItemPartCollectionType: properties: itemParts: description: | Container for payment part items. items: $ref: '#/components/schemas/GETPaymentItemPartTypewithSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: object GETPaymentItemPartTypewithSuccess: properties: amount: description: | The amount of the payment part item. format: double type: number createdById: description: | The ID of the Zuora user who created the payment part item. type: string createdDate: description: | The date and time when the payment part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoItemId: description: | The ID of the debit memo item associated with the payment part item. type: string id: description: | The ID of the payment part item. type: string invoiceItemId: description: | The ID of the invoice item associated with the payment part item. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string taxItemId: description: | The ID of the taxation item associated with the payment part item. type: string updatedById: description: | The ID of the Zuora user who last updated the payment part item. type: string updatedDate: description: | The date and time when the payment part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string title: itemParts type: object GETPaymentItemPartType: properties: amount: description: | The amount of the payment part item. format: double type: number createdById: description: | The ID of the Zuora user who created the payment part item. type: string createdDate: description: | The date and time when the payment part item was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string debitMemoItemId: description: | The ID of the debit memo item associated with the payment part item. type: string id: description: | The ID of the payment part item. type: string invoiceItemId: description: | The ID of the invoice item associated with the payment part item. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string success: description: Returns `true` if the request was processed successfully. type: boolean taxItemId: description: | The ID of the taxation item associated with the payment part item. type: string updatedById: description: | The ID of the Zuora user who last updated the payment part item. type: string updatedDate: description: | The date and time when the payment part item was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object PostRefundType: allOf: - properties: comment: description: | Comments about the refund. maxLength: 255 minLength: 0 type: string customRates: description: | It contains Home currency and Reporting currency custom rates currencies. The maximum number of items is 2 (you can pass the Home currency item, Reporting currency item, or both). **Note**: - This field is only available if you are on the latest Zuora API minor version, or you set the `Zuora-Version` request header to `224.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version). - You cannot set the custom rates, if both the **Automatically include additional Currency Conversion information in data source exports** option and **Fx data** feature are enabled. items: $ref: '#/components/schemas/PaymentWithCustomRatesType' maxItems: 2 type: array financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. maxLength: 100 minLength: 0 type: string transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. maxLength: 100 minLength: 0 type: string type: object gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object methodType: description: | How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string refundDate: description: | The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds. format: date type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string softDescriptor: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 35 type: string softDescriptorPhone: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 20 type: string totalAmount: description: | The total amount of the refund. The amount cannot exceed the unapplied amount of the associated payment. If the original payment was applied to one or more invoices or debit memos, you have to unapply a full or partial payment from the invoices or debit memos, and then refund the full or partial unapplied payment to your customers. format: double type: number type: description: | The type of the refund. enum: - External - Electronic type: string refundTransactionType: description: | The transaction type of the refund. enum: - Chargeback - PaymentReversal type: string required: - totalAmount - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' example: type: Electronic totalAmount: 10 GETRefundPaymentType: allOf: - properties: accountId: description: | The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment. type: string amount: description: | The total amount of the refund. format: double type: number cancelledOn: description: | The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true comment: description: | Comments about the refund. type: string createdById: description: | The ID of the Zuora user who created the refund. type: string createdDate: description: | The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditMemoId: description: | The ID of the credit memo associated with the refund. type: string financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string nullable: true bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string nullable: true transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string nullable: true unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string nullable: true type: object gatewayId: description: | The ID of the gateway instance that processes the refund. type: string gatewayReconciliationReason: description: | The reason of gateway reconciliation. type: string nullable: true gatewayReconciliationStatus: description: | The status of gateway reconciliation. type: string nullable: true gatewayResponse: description: | The message returned from the payment gateway for the refund. This message is gateway-dependent. type: string gatewayResponseCode: description: | The code returned from the payment gateway for the refund. This code is gateway-dependent. type: string gatewayState: description: | The status of the refund in the gateway. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The ID of the created refund. type: string markedForSubmissionOn: description: | The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string nullable: true methodType: description: | How an external refund was issued to a customer. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: description: | The unique identification number of the refund. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string paymentGatewayNumber: description: | The natural key for the payment gateway. type: string paymentId: description: | The ID of the payment that is refunded. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the refund. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. type: string payoutId: description: | The payout ID of the refund from the gateway side. type: string nullable: true reasonCode: description: | A code identifying the reason for the transaction. type: string referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. type: string nullable: true refundDate: description: | The date when the refund takes effect, in `yyyy-mm-dd` format. format: date type: string refundTransactionTime: description: | The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. type: string nullable: true settledOn: description: | The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string nullable: true softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string nullable: true status: description: | The status of the refund. enum: - Processed - Canceled - Error - Processing type: string submittedOn: description: | The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: description: | The type of the refund. enum: - External - Electronic type: string updatedById: description: | The ID of the the Zuora user who last updated the refund. type: string updatedDate: description: | The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' PostRefundwithAutoUnapplyType: allOf: - properties: comment: description: | Comments about the refund. maxLength: 255 minLength: 0 type: string debitMemos: description: | Container for debit memos. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationApplyRequestType' type: array financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. maxLength: 100 minLength: 0 type: string transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. maxLength: 100 minLength: 0 type: string type: object gatewayOptions: description: | The field used to pass gateway-specific parameters and parameter values. The fields supported by gateways vary. For more information, see the Overview topic of each gateway integration in [Zuora Knowledge Center](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways). Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts. properties: key: description: | The name of a gateway-specific parameter. type: string value: description: | The value of the gateway-specific parameter. type: string type: object invoices: description: | Container for invoices. The maximum number of invoices is 1,000. items: $ref: '#/components/schemas/PaymentInvoiceApplicationApplyRequestType' type: array methodType: description: | How an external refund was issued to a customer. This field is required for an external refund and must be left empty for an electronic refund. You can issue an external refund on an electronic payment. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string reasonCode: description: | A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code. type: string referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string refundDate: description: | The date when the refund takes effect, in `yyyy-mm-dd` format. The date of the refund cannot be before the payment date. Specify this field only for external refunds. Zuora automatically generates this field for electronic refunds. format: date type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. maxLength: 100 minLength: 0 type: string softDescriptor: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 35 type: string softDescriptorPhone: description: A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. maxLength: 20 type: string totalAmount: description: | The total amount of the refund. If you do not specify a value, Zuora initiates a full refund of the payment amount, which is the sum of the applied and unapplied payment amounts. - `Full Refund`: If the refund amount and debit memo/ invoice are not specified, then the payment will be unapplied completely, followed by processing a full refund. - `Partial Refund`: - If the total amount is specified, and the debit memo/invoice is not specified, you can unapply the refund amount from the available debit memo/invoice and refund the unapplied payment to the customer. - If the total amount is specified, along with the debit memo and the invoice, you can unapply the applied payments from the mentioned invoices and debit memos, and refund the unapplied payments to customers. format: double type: number type: description: | The type of the refund. enum: - External - Electronic type: string refundTransactionType: description: | The transaction type of the refund. enum: - Chargeback - PaymentReversal type: string writeOff: default: false description: | Indicates whether to write off a document. type: boolean writeOffOptions: description: | Container for the write-off information to create credit memo. properties: comment: description: | Comments about the credit memo which is created as a result of the write off. maxLength: 100 type: string memoDate: description: | The date when the credit memo takes effect. format: date type: string reasonCode: description: | A code identifying the reason for the credit memo. type: string taxAutoCalculation: description: | Indicates whether to automatically calculate taxes in the credit memo. type: boolean type: object required: - type type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' example: type: Electronic totalAmount: 10 GETRefundPaymentTypeAutoUnapply: allOf: - properties: accountId: description: | The ID of the account associated with this refund. Zuora associates the refund automatically with the account from the associated payment. type: string amount: description: | The total amount of the refund. format: double type: number cancelledOn: description: | The date and time when the refund was cancelled, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string comment: description: | Comments about the refund. type: string createdById: description: | The ID of the Zuora user who created the refund. type: string createdDate: description: | The date and time when the refund was created, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-01 15:31:10. format: date-time type: string creditMemoId: description: | The ID of the credit memo associated with the refund. type: string financeInformation: description: | Container for the finance information related to the refund. properties: bankAccountAccountingCode: description: | The accounting code that maps to a bank account in your accounting system. type: string bankAccountAccountingCodeType: description: | The type of the accounting code that maps to a bank account in your accounting system. type: string transferredToAccounting: description: | Whether the refund was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite. enum: - Processing - 'Yes' - 'No' - Error - Ignore type: string unappliedPaymentAccountingCode: description: | The accounting code for the unapplied payment. type: string unappliedPaymentAccountingCodeType: description: | The type of the accounting code for the unapplied payment. type: string type: object gatewayId: description: | The ID of the gateway instance that processes the refund. type: string gatewayReconciliationReason: description: | The reason of gateway reconciliation. type: string gatewayReconciliationStatus: description: | The status of gateway reconciliation. type: string gatewayResponse: description: | The message returned from the payment gateway for the refund. This message is gateway-dependent. type: string gatewayResponseCode: description: | The code returned from the payment gateway for the refund. This code is gateway-dependent. type: string gatewayState: description: | The status of the refund in the gateway. enum: - MarkedForSubmission - Submitted - Settled - NotSubmitted - FailedToSettle type: string id: description: | The ID of the created refund. type: string markedForSubmissionOn: description: | The date and time when a refund was marked and waiting for batch submission to the payment process, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string methodType: description: | How an external refund was issued to a customer. enum: - ACH - Cash - Check - CreditCard - PayPal - WireTransfer - DebitCard - CreditCardReferenceTransaction - BankTransfer - Other type: string number: description: | The unique identification number of the refund. type: string paymentGatewayNumber: description: | The natural key for the payment gateway. type: string paymentId: description: | The ID of the payment that is refunded. type: string paymentMethodId: description: | The unique ID of the payment method that the customer used to make the refund. type: string paymentMethodSnapshotId: description: | The unique ID of the payment method snapshot, which is a copy of the particular payment method used in a transaction. type: string payoutId: description: | The payout ID of the refund from the gateway side. type: string reasonCode: description: | A code identifying the reason for the transaction. type: string referenceId: description: | The transaction ID returned by the payment gateway for an electronic refund. Use this field to reconcile refunds between your gateway and Zuora Payments. type: string refundDate: description: | The date when the refund takes effect, in `yyyy-mm-dd` format. format: date type: string refundTransactionTime: description: | The date and time when the refund was issued, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string secondRefundReferenceId: description: | The transaction ID returned by the payment gateway if there is an additional transaction for the refund. Use this field to reconcile payments between your gateway and Zuora Payments. type: string settledOn: description: | The date and time when the refund was settled in the payment processor, in `yyyy-mm-dd hh:mm:ss` format. This field is used by the Spectrum gateway only and not applicable to other gateways. format: date-time type: string softDescriptor: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string softDescriptorPhone: description: | A payment gateway-specific field that maps to Zuora for the gateways, Orbital, Vantiv and Verifi. type: string status: description: | The status of the refund. enum: - Processed - Canceled - Error - Processing type: string submittedOn: description: | The date and time when the refund was submitted, in `yyyy-mm-dd hh:mm:ss` format. format: date-time type: string success: description: Returns `true` if the request was processed successfully. type: boolean type: description: | The type of the refund. enum: - External - Electronic type: string updatedById: description: | The ID of the the Zuora user who last updated the refund. type: string updatedDate: description: | The date and time when the refund was last updated, in `yyyy-mm-dd hh:mm:ss` format. For example, 2017-03-02 15:36:10. format: date-time type: string writeOffResults: description: | Container for the write-off information of credit memo and apply information. properties: errorMessage: description: | The error message about write off failed. type: string transactions: description: | The credit memo apply information. properties: appliedAmount: description: | The credit memo applied amopunt. format: double type: number creditMemoAmount: description: | The credit memo amount. type: string creditMemoNumber: description: | The unique identification number of the credit memo. type: string creditMemoStatus: description: | The status of the credit memo. enum: - Draft - Posted - Canceled - Error - PendingForTax - Generating - CancelInProgress type: string invoiceNumber: description: | The unique identification number of the invoice. type: string title: transactions type: object type: object type: object - $ref: '#/components/schemas/RefundObjectNSFields' - $ref: '#/components/schemas/RefundObjectCustomFields' TransferPaymentType: example: accountId: 4028905f5a87c0ff015a88889fe500a8 properties: accountId: description: | The ID of the customer account that the payment is transferred to. Unassign a payment by setting this field to an empty string. This will automatically transfer the payment to a null account. type: string type: object UnapplyPaymentType: example: invoices: - invoiceId: 8ad097b490c4e5aa0190c9b931817cef amount: 12 properties: debitMemos: description: | Container for debit memos. The maximum number of debit memos is 1,000. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationUnapplyRequestType' type: array effectiveDate: description: | The date when the payment is unapplied, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment. format: date type: string invoices: description: | Container for invoices. The maximum number of invoice is 1,000. items: $ref: '#/components/schemas/PaymentInvoiceApplicationUnapplyRequestType' type: array type: object PaymentDebitMemoApplicationUnapplyRequestType: properties: amount: description: | The amount of the payment that is unapplied from the debit memo. format: double type: number debitMemoId: description: | The unique ID of the debit memo that the payment is unapplied from. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string debitMemoNumber: description: | The number of the debit memo that the payment is unapplied from. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for debit memo items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentDebitMemoApplicationItemUnapplyRequestType' type: array required: - amount title: debitMemos type: object PaymentInvoiceApplicationUnapplyRequestType: properties: amount: description: | The amount of the payment that is unapplied from the invoice. format: double type: number invoiceId: description: | The unique ID of the invoice that the payment is unapplied from. **Note:** - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string invoiceNumber: description: | The number of the invoice that the payment is unapplied from. For example, `INV00000001`. **Note:** When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other. - The Payment Cross Account (PCA) feature is in the Early Adopter phase. - When PCA is enabled for the tenant, you can specify a debit memo / invoice that is different from the account that is specified in the request body. type: string items: description: | Container for invoice items. The maximum number of items is 1,000. **Note:** This field is only available if you have the [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. items: $ref: '#/components/schemas/PaymentInvoiceApplicationItemUnapplyRequestType' type: array required: - amount title: invoices type: object PaymentInvoiceApplicationItemUnapplyRequestType: properties: amount: description: | The amount of the payment that is unapplied from the specific invoice or taxation item. format: double type: number invoiceItemId: description: | The ID of the specific invoice item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object PaymentDebitMemoApplicationItemUnapplyRequestType: properties: amount: description: | The amount of the payment that is unapplied from the specific debit mem or taxation item. format: double type: number debitMemoItemId: description: | The ID of the specific debit memo item. type: string taxItemId: description: | The ID of the specific taxation item. type: string required: - amount title: items type: object SummaryStatementRunRequestType: type: object properties: runType: description: | The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only `AdHoc` is supported. enum: - AdHoc type: string targetAccountCategory: description: | Specifies the type of account filter. If the filter type is set to `AllAccounts`, `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`, `AccountsWithoutInvoices`, or `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the filter using `batchName` and `billCycleDay`. However, these criteria are not applicable when the filter type is `SingleAccount`. enum: - SingleAccount - AllAccounts - AccountsWithOpenInvoices - AccountsWithOpenBalances - AccountsWithoutInvoices - AccountsWithoutInvoicesAndOpenBalances type: string accountKey: description: | The related account ID or account number when the filter type is `SingleAccount`. nullable: true type: string batchName: description: | The batch name used for filtering accounts, for example, Batch1. type: string billCycleDay: description: | The bill cycle day for filtering accounts, with values ranging from '01' to '31'. nullable: true type: string dateRangeType: description: | The date range for the statement. If `PreviousThreeCalendarMonth` or `PreviousOneCalendarMonth` is selected, the start and end dates are automatically calculated. For example, if `PreviousThreeCalendarMonth` is chosen today (2024-08-20), the dates would be 2024-05-01 to 2024-07-31. enum: - Custom - PreviousThreeCalendarMonth - PreviousOneCalendarMonth type: string startDate: description: | Required when `Custom` is selected for the date range. The start date can be set to a maximum of 5 years in the past and must follow the format YYYY-MM-DD. format: date type: string endDate: description: | When creating a statement run, this field cannot be manually entered. If `Custom` is selected, the end date automatically defaults to today’s date in the tenant’s timezone. format: date type: string autoEmailEnabled: description: | Indicates whether to send an email after a statement is generated. Acceptable values are `true` or `false`. If unspecified, the default value is `false`. type: boolean description: description: | A text description of the statement run. type: string required: - runType - targetAccountCategory - dateRangeType SummaryStatementRunResponse: properties: id: description: | The unique identifier for the statement run. type: string statementRunNumber: description: | The number of the statement run. type: string runType: description: | The scheduled type of the run which can either be AdHoc or Scheduled. Currently, only `AdHoc` is supported. enum: - AdHoc type: string targetAccountCategory: description: | Specifies the type of account filter. If the filter type is set to `AllAccounts`, `AccountsWithOpenInvoices`, `AccountsWithOpenBalances`, `AccountsWithoutInvoices`, or `AccountsWithoutInvoicesAndOpenBalances`, you can further refine the filter using `batchName` and `billCycleDay`. However, these criteria are not applicable when the filter type is `SingleAccount`. enum: - SingleAccount - AllAccounts - AccountsWithOpenInvoices - AccountsWithOpenBalances - AccountsWithoutInvoices - AccountsWithoutInvoicesAndOpenBalances type: string accountKey: description: | When the filter type is `SingleAccount`, this field contains the related account ID. type: string nullable: true batchName: description: | The name of the batch used for filtering accounts. type: string billCycleDay: description: | The bill cycle day for filtering accounts, with values ranging from '01' to '31'. type: string nullable: true dateRangeType: description: | The date range for the statement. enum: - PreviousThreeCalendarMonth - PreviousOneCalendarMonth - PreviousOneCalendarMonth type: string startDate: description: | The start date. format: date type: string endDate: description: | The end date, which defaults to today’s date when `Custom` is selected. This field cannot be manually entered. format: date type: string autoEmailEnabled: description: | Indicates whether to send an email after a statement is generated. type: boolean description: description: | A text description of the statement run. type: string status: description: | The status of the run. enum: - Pending - Processing - Completed - Error - Terminated type: string createdById: description: | The ID of the user who created the statement run. type: string createdDate: description: | The date and time the statement run was created. type: string format: dateTime success: description: | Indicates whether the operation was successful. type: boolean updatedById: description: | The ID of the user who last updated the statement run. type: string updatedDate: description: | The date the statement run was last updated. type: string format: dateTime type: object GETAccountingCodesType: properties: accountingCodes: description: | An array of all the accounting codes in your chart of accounts. Each accounting code has the following fields. items: $ref: '#/components/schemas/GETAccountingCodeItemWithoutSuccessType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETAccountingCodeItemWithoutSuccessType: allOf: - properties: category: description: | The category associated with the accounting code. enum: - Assets - Liabilities - Equity - Revenue - Expenses type: string createdBy: description: | The ID of the user who created the accounting code. type: string createdOn: description: | Date and time when the accounting code was created. format: date-time type: string glAccountName: description: | Name of the account in your general ledger. Field only available if you have Zuora Finance enabled. type: string glAccountNumber: description: | Account number in your general ledger. Field only available if you have Zuora Finance enabled. type: string id: description: | ID of the accounting code. type: string name: description: | Name of the accounting code. type: string notes: description: | Any optional notes for the accounting code. type: string status: description: | The accounting code status. enum: - Active - Inactive type: string type: description: | Accounting code type. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string updatedBy: description: | The ID of the user who last updated the accounting code. type: string updatedOn: description: | Date and time when the accounting code was last updated. format: date-time type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' title: accountingCodes SegmentConstantValuesCustomFields: description: | Segment constant values. The field is available only if you have GL Segmentation 2.0 enabled. This field is additional property. title: segmentConstantValues type: object AccountingCodeObjectCustomFields: additionalProperties: description: | Custom fields of the Accounting Code object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Accounting Code object. title: accountingCodeFieldsCustom type: object POSTAccountingCodeType: allOf: - properties: glAccountName: description: | Name of the account in your general ledger. Field only available if you have Zuora Finance enabled. Maximum of 255 characters. type: string glAccountNumber: description: | Account number in your general ledger. Field only available if you have Zuora Finance enabled. Maximum of 255 characters. type: string name: description: | Name of the accounting code. Accounting code name must be unique. Maximum of 100 characters. type: string notes: description: | Maximum of 2,000 characters. type: string type: description: | If you want to create multiple accounting codes of the type `AccountsReceivable`, you need to have [Invoice Item Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/C_Invoice_Item_Settlement) enabled and contact [Zuora Global Support](http://support.zuora.com) to access the Multiple AR Accounting Codes feature. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' required: - name - type type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' example: name: CASH type: Cash POSTAccountingCodeResponseType: properties: id: description: | ID of the newly created accounting code. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETAccountingCodeItemType: allOf: - properties: category: description: | The category associated with the accounting code. enum: - Assets - Liabilities - Equity - Revenue - Expenses type: string createdBy: description: | The ID of the user who created the accounting code. type: string createdOn: description: | Date and time when the accounting code was created. format: date-time type: string glAccountName: description: | Name of the account in your general ledger. Field only available if you have Zuora Finance enabled. type: string glAccountNumber: description: | Account number in your general ledger. Field only available if you have Zuora Finance enabled. type: string id: description: | ID of the accounting code. type: string name: description: | Name of the accounting code. type: string notes: description: | Any optional notes for the accounting code. type: string status: description: | The accounting code status. enum: - Active - Inactive type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: description: | Accounting code type. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string updatedBy: description: | The ID of the user who last updated the accounting code. type: string updatedOn: description: | Date and time when the accounting code was last updated. format: date-time type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' PUTAccountingCodeType: allOf: - properties: glAccountName: description: | Name of the account in your general ledger. Field only available if you have Zuora Finance enabled. Maximum of 255 characters. type: string glAccountNumber: description: | Account number in your general ledger. Field only available if you have Zuora Finance enabled. Maximum of 255 characters. type: string name: description: | Name of the accounting code. Accounting code name must be unique. Maximum of 100 characters. type: string notes: description: | Maximum of 2,000 characters. type: string type: description: | Accounting code type. You cannot change the type of an accounting code from `AccountsReceivable` to a different type. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string segmentConstantValues: $ref: '#/components/schemas/SegmentConstantValuesCustomFields' type: object - $ref: '#/components/schemas/AccountingCodeObjectCustomFields' example: notes: Details of the accounting code GETAccountingPeriodsType: properties: accountingPeriods: description: | An array of all accounting periods on your tenant. The accounting periods are returned in ascending order of start date; that is, the latest period is returned first. items: $ref: '#/components/schemas/GETAccountingPeriodWithoutSuccessType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETAccountingPeriodWithoutSuccessType: allOf: - properties: createdBy: description: | ID of the user who created the accounting period. type: string createdOn: description: | Date and time when the accounting period was created. format: date-time type: string endDate: description: | The end date of the accounting period. format: date type: string fileIds: description: | File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a [Get Files](https://developer.zuora.com/api-references/api/operation/GET_Files) REST API call. properties: accountsReceivableAccountAgingDetailExportFileId: description: | File ID of the Accounts Receivable Aging Account Detail report. type: string accountsReceivableInvoiceAgingDetailExportFileId: description: | File ID of the Accounts Receivable Aging Invoice Detail report. type: string arRollForwardDetailExportFileId: description: | File ID of the Accounts Receivable Detail report. type: string fxRealizedGainAndLossDetailExportFileId: description: | File ID of the Realized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled. type: string fxUnrealizedGainAndLossDetailExportFileId: description: | File ID of the Unrealized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled type: string revenueDetailCsvFileId: description: | File ID of the Revenue Detail report in CSV format. type: string revenueDetailExcelFileId: description: | File ID of the Revenue Detail report in XLSX format. type: string unprocessedChargesFileId: description: | File ID of a report containing all unprocessed charges for the accounting period. type: string type: object fiscalYear: description: | Fiscal year of the accounting period. type: integer fiscalQuarter: description: Fiscal quarter of the accounting period. type: integer id: description: | ID of the accounting period. type: string name: description: | Name of the accounting period. type: string notes: description: | Any optional notes about the accounting period. type: string organizationLabels: description: | The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array runTrialBalanceEnd: description: | Date and time that the trial balance was completed. If the trial balance status is `Pending`, `Processing`, or `Error`, this field is `null`. format: date-time type: string runTrialBalanceErrorMessage: description: | If trial balance status is Error, an error message is returned in this field. type: string runTrialBalanceStart: description: | Date and time that the trial balance was run. If the trial balance status is `Pending`, this field is `null`. format: date-time type: string runTrialBalanceStatus: description: | Status of the trial balance for the accounting period. Possible values: * `Pending` * `Processing` * `Completed` * `Error` type: string startDate: description: | The start date of the accounting period. format: date type: string status: description: | Status of the accounting period. Possible values: * `Open` * `PendingClose` * `Closed` type: string updatedBy: description: | D of the user who last updated the accounting period. type: string updatedOn: description: | Date and time when the accounting period was last updated. format: date-time type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' title: accountingPeriods AccountingPeriodObjectCustomFields: additionalProperties: description: | Custom fields of the Accounting Period object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of an Accounting Period object. title: accountingPeriodFieldsCustom type: object POSTAccountingPeriodType: allOf: - properties: endDate: description: | The end date of the accounting period in yyyy-mm-dd format, for example, "2016-02-19". format: date type: string fiscalYear: description: | Fiscal year of the accounting period in yyyy format, for example, "2016". type: integer fiscalQuarter: description: Fiscal quarter of the accounting period. One number between 1 and 4. type: integer minimum: 1 maximum: 4 name: description: | Name of the accounting period. Accounting period name must be unique. Maximum of 100 characters. type: string notes: description: | Notes about the accounting period. Maximum of 255 characters. type: string organizationLabels: description: | The organization that the accounting period belongs to. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array startDate: description: | The start date of the accounting period in yyyy-mm-dd format, for example, "2016-02-19". format: date type: string required: - name - startDate - endDate - fiscalYear type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' example: name: Jun 2016 fiscalYear: 2016 startDate: '2016-06-01' endDate: '2016-06-30' POSTAccountingPeriodResponseType: properties: id: description: | ID of the newly-created accounting period. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETAccountingPeriodType: allOf: - properties: createdBy: description: | ID of the user who created the accounting period. type: string createdOn: description: | Date and time when the accounting period was created. format: date-time type: string endDate: description: | The end date of the accounting period. format: date type: string fileIds: description: | File IDs of the reports available for the accounting period. You can retrieve the reports by specifying the file ID in a [Get Files](https://developer.zuora.com/api-references/api/operation/GET_Files) REST API call. properties: accountsReceivableAccountAgingDetailExportFileId: description: | File ID of the Accounts Receivable Aging Account Detail report. type: string accountsReceivableInvoiceAgingDetailExportFileId: description: | File ID of the Accounts Receivable Aging Invoice Detail report. type: string accountsReceivableDebitMemoAgingDetailExportFileId: description: | File ID of the Accounts Receivable Aging Debit Memo Detail report. type: string arRollForwardDetailExportFileId: description: | File ID of the Accounts Receivable Detail report. type: string fxRealizedGainAndLossDetailExportFileId: description: | File ID of the Realized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled. type: string fxUnrealizedGainAndLossDetailExportFileId: description: | File ID of the Unrealized Gain and Loss Detail report. Returned only if you have Foreign Currency Conversion enabled type: string revenueDetailCsvFileId: description: | File ID of the Revenue Detail report in CSV format. type: string revenueDetailExcelFileId: description: | File ID of the Revenue Detail report in XLSX format. type: string unprocessedChargesFileId: description: | File ID of a report containing all unprocessed charges for the accounting period. type: string type: object fiscalYear: description: | Fiscal year of the accounting period. type: integer fiscalQuarter: description: Fiscal quarter of the accounting period. type: integer id: description: | ID of the accounting period. type: string name: description: | Name of the accounting period. type: string notes: description: | Any optional notes about the accounting period. type: string organizationLabels: description: | The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array runTrialBalanceEnd: description: | Date and time that the trial balance was completed. If the trial balance status is `Pending`, `Processing`, or `Error`, this field is `null`. format: date-time type: string runTrialBalanceErrorMessage: description: | If trial balance status is Error, an error message is returned in this field. type: string runTrialBalanceStart: description: | Date and time that the trial balance was run. If the trial balance status is Pending, this field is null. format: date-time type: string runTrialBalanceStatus: description: | Status of the trial balance for the accounting period. Possible values: * `Pending` * `Processing` * `Completed` * `Error` type: string startDate: description: | The start date of the accounting period. format: date type: string status: description: | Status of the accounting period. Possible values: * `Open` * `PendingClose` * `Closed` type: string success: description: | Returns `true` if the request was processed successfully. type: boolean updatedBy: description: | ID of the user who last updated the accounting period. type: string updatedOn: description: | Date and time when the accounting period was last updated. format: date-time type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' PUTAccountingPeriodType: allOf: - properties: endDate: description: | The end date of the accounting period in yyyy-mm-dd format, for example, "2016-02-19". format: date type: string fiscalYear: description: | Fiscal year of the accounting period in yyyy format, for example, "2016". type: integer fiscalQuarter: description: Fiscal quarter of the accounting period. One number between 1 and 4. type: integer minimum: 1 maximum: 4 name: description: | Name of the accounting period. Accounting period name must be unique. Maximum of 100 characters. type: string notes: description: | Notes about the accounting period. Maximum of 255 characters. type: string startDate: description: | The start date of the accounting period in yyyy-mm-dd format, for example, "2016-02-19". format: date type: string type: object - $ref: '#/components/schemas/AccountingPeriodObjectCustomFields' example: notes: Details of the accounting period POSTJournalEntryType: allOf: - properties: accountingPeriodName: description: | Name of the accounting period. The open-ended accounting period is named `Open-Ended`. type: string currency: description: | The type of currency used. Currency must be active. type: string journalEntryDate: description: | Date of the journal entry. format: date type: string journalEntryItems: description: | Key name that represents the list of journal entry items. items: $ref: '#/components/schemas/POSTJournalEntryItemType' type: array notes: description: | The number associated with the revenue event. Character limit: 2,000 type: string organizationLabel: description: | Name of the organization that the journal entry belongs to. This field is only required when you have already turned on Multi-Org feature. type: string segments: description: | List of segments that apply to the summary journal entry. items: $ref: '#/components/schemas/POSTJournalEntrySegmentType' type: array transferredToAccounting: description: | Status shows whether the journal entry has been transferred to an accounting system. enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string required: - journalEntryDate - accountingPeriodName - currency - journalEntryItems type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' example: accountingPeriodName: 2020/02 currency: USD journalEntryDate: '2020-01-20' journalEntryItems: - accountingCodeName: Accounts Receivable amount: 400.9 homeCurrencyAmount: 400.9 type: Credit - accountingCodeName: Subscription Revenue amount: 400.9 homeCurrencyAmount: 400.9 type: Debit POSTJournalEntryResponseType: properties: journalEntryNumber: description: | Journal entry number in the format JE-00000001. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTJournalEntryItemType: allOf: - properties: accountingCodeName: description: | Name of the accounting code. type: string accountingCodeType: description: | Accounting code type. This field is required if `accountingCodeName` is not unique. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string amount: description: | Journal entry item amount in transaction currency. format: decimal type: string homeCurrencyAmount: description: | Journal entry item amount in home currency. This field is required if you have set your home currency for foreign currency conversion. Otherwise, do not pass this field. format: decimal type: string type: description: 'Type of journal entry item. ' enum: - Credit - Debit type: string required: - accountingCodeName - type - amount type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems POSTJournalEntrySegmentType: properties: segmentName: description: 'Name of segment. You must use the segment name that has already been specified in the default segment rule. In addition, segments need to be passed in the order where they were defined in the segmentation rule. If multiple segments are configured in the default rule, you need to specify all of them in order. ' type: string segmentValue: description: | Value of segment in this summary journal entry. type: string required: - segmentName - segmentValue title: segments type: object JournalEntryObjectCustomFields: additionalProperties: description: | Custom fields of the Journal Entry object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Journal Entry object. title: journalEntryFieldsCustom type: object JournalEntryItemObjectCustomFields: additionalProperties: description: | Custom fields of the Journal Entry Item object. The name of each custom field has the form *customField*__c. Custom field names are case sensitive. See Custom Fields for more information. description: | Container for custom fields of a Journal Entry Item object. title: journalEntryItemFieldsCustom type: object GETJournalEntriesInJournalRunType: properties: journalEntries: description: | Key name that represents the list of journal entries. items: $ref: '#/components/schemas/GETJournalEntryDetailTypeWithoutSuccess' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETJournalEntryDetailTypeWithoutSuccess: allOf: - properties: accountingPeriodName: description: | Name of the accounting period that the journal entry belongs to. type: string aggregateCurrency: description: | Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the `Aggregate transactions with different currencies during a JournalRun` setting was configured to "Yes". Otherwise, returns `false`. type: boolean currency: description: | Currency used. type: string homeCurrency: description: | Home currency used. type: string journalEntryDate: description: | Date of the journal entry. format: date type: string journalEntryItems: description: | Key name that represents the list of journal entry items. items: $ref: '#/components/schemas/GETJournalEntryItemType' type: array notes: description: | Additional information about this record. Character limit: 2,000 type: string number: description: | Journal entry number in the format JE-00000001. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string segments: description: | List of segments that apply to the summary journal entry. items: $ref: '#/components/schemas/GETJournalEntrySegmentType' type: array status: description: 'Status of journal entry. ' enum: - Created - Cancelled type: string timePeriodEnd: description: | End date of time period included in the journal entry. format: date type: string timePeriodStart: description: | Start date of time period included in the journal entry. format: date type: string transactionType: description: | Transaction type of the transactions included in the summary journal entry. type: string transferDateTime: description: | Date and time that transferredToAccounting was changed to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`. format: date-time type: string transferredBy: description: | User ID of the person who changed transferredToAccounting to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`. type: string transferredToAccounting: description: 'Status shows whether the journal entry has been transferred to an accounting system. ' enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' title: journalEntries GETJournalEntryItemType: allOf: - properties: accountingCodeName: description: | Name of the accounting code. type: string accountingCodeType: description: | Accounting code type. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string amount: description: | Journal entry item amount in transaction currency. format: decimal type: string glAccountName: description: | The account number in the general ledger (GL) that corresponds to the accounting code. type: string glAccountNumber: description: | The account name in the general ledger (GL) that corresponds to the accounting code. type: string homeCurrencyAmount: description: | Journal entry item amount in home currency. format: decimal type: string type: description: 'Type of journal entry item. ' enum: - Credit - Debit type: string type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems GETJournalEntrySegmentType: properties: segmentName: description: | Name of segment. type: string segmentValue: description: | Value of segment in this summary journal entry. type: string title: segments type: object GETJournalEntryDetailType: allOf: - properties: accountingPeriodName: description: | Name of the accounting period that the journal entry belongs to. type: string aggregateCurrency: description: | Returns true if the journal entry is aggregating currencies. That is, if the journal entry was created when the `Aggregate transactions with different currencies during a Journal Run` setting was configured to `Yes`. Otherwise, returns `false`. type: boolean currency: description: | Currency used. type: string homeCurrency: description: | Home currency used. type: string journalEntryDate: description: | Date of the journal entry. format: date type: string journalEntryItems: description: | Key name that represents the list of journal entry items. items: $ref: '#/components/schemas/GETJournalEntryItemType' type: array notes: description: | Additional information about this record. Character limit: 2,000 type: string number: description: | Journal entry number in the format JE-00000001. type: string organizationLabel: description: | The organization that this object belongs to. Note: This field is available only when the Multi-Org feature is enabled. type: string segments: description: | List of segments that apply to the summary journal entry. items: $ref: '#/components/schemas/GETJournalEntrySegmentType' type: array status: description: | Status of journal entry. enum: - Created - Cancelled type: string success: description: | Returns `true` if the request was processed successfully. type: boolean timePeriodEnd: description: | End date of time period included in the journal entry. format: date type: string timePeriodStart: description: | Start date of time period included in the journal entry. format: date type: string transactionType: description: | Transaction type of the transactions included in the summary journal entry. type: string transferDateTime: description: | Date and time that transferredToAccounting was changed to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`. format: date-time type: string transferredBy: description: | User ID of the person who changed transferredToAccounting to `Yes`. This field is returned only when transferredToAccounting is `Yes`. Otherwise, this field is `null`. type: string transferredToAccounting: description: 'Status shows whether the journal entry has been transferred to an accounting system. ' enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' PUTBasicSummaryJournalEntryType: allOf: - properties: journalEntryItems: description: | Key name that represents the list of journal entry items. items: $ref: '#/components/schemas/PUTJournalEntryItemType' type: array notes: description: | Additional information about this record. ***Character limit:*** 2,000 type: string transferredToAccounting: description: | Status shows whether the journal entry has been transferred to an accounting system. This field cannot be changed after the summary journal entry has been canceled. **Note:** The Zuora Finance ***Override Transferred to Accounting*** permission is required to change `transferredToAccounting` from `Yes` to any other value. enum: - 'No' - Processing - 'Yes' - Error - Ignore type: string type: object - $ref: '#/components/schemas/JournalEntryObjectCustomFields' example: transferredToAccounting: 'Yes' PUTJournalEntryItemType: allOf: - properties: accountingCodeName: description: | Name of the accounting code. If the Journal Entry Item has a blank accounting code, enter the empty string. type: string accountingCodeType: description: | Accounting code type. Note that `On-Account Receivable` is only available if you enable the Invoice Settlement feature. enum: - AccountsReceivable - On-Account Receivable - Cash - OtherAssets - CustomerCashOnAccount - DeferredRevenue - SalesTaxPayable - OtherLiabilities - SalesRevenue - SalesDiscounts - OtherRevenue - OtherEquity - BadDebt - OtherExpenses type: string type: description: 'Type of journal entry item. ' enum: - Credit - Debit type: string required: - accountingCodeName - type type: object - $ref: '#/components/schemas/JournalEntryItemObjectCustomFields' title: journalEntryItems POSTJournalRunType: example: accountingPeriodName: Nov-2014 journalEntryDate: '2014-11-04' transactionTypes: - type: Invoice Item - type: Revenue Event Item properties: accountingPeriodName: description: | Name of the accounting period. This field determines the target start and end dates of the journal run. Required if you do not include `targetStartDate` and `targetEndDate`. type: string journalEntryDate: description: | Date of the journal entry. format: date type: string organizationLabels: description: | The organization that this run is created for. For each item in the array, either the `organizationId` or the `organizationName` field is required. This field is only required when you have already turned on Multi-Org feature. properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object targetEndDate: description: | The target end date of the journal run. If you include `accountingPeriodName`, the `targetEndDate` must be empty or the same as the end date of the accounting period specified in `accountingPeriodName`. format: date type: string targetStartDate: description: | The target start date of the journal run. Required if you include targetEndDate. If you include `accountingPeriodName`, the `targetStartDate` must be empty or the same as the start date of the accounting period specified in `accountingPeriodName`. format: date type: string transactionTypes: description: | Transaction types included in the journal run. You can include one or more transaction types. items: $ref: '#/components/schemas/POSTJournalRunTransactionType' type: array required: - transactionTypes - journalEntryDate type: object POSTJournalRunResponseType: properties: journalRunNumber: description: | Journal run number. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object POSTJournalRunTransactionType: properties: type: description: | Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead. If you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. If you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. enum: - Invoice Item - Taxation Item - Invoice Item Adjustment (Invoice) - Invoice Item Adjustment (Tax) - Invoice Adjustment - Electronic Payment - External Payment - Electronic Refund - External Refund - Electronic Credit Balance Payment - External Credit Balance Payment - Electronic Credit Balance Refund - External Credit Balance Refund - Credit Balance Adjustment (Applied from Credit Balance) - Credit Balance Adjustment (Transferred to Credit Balance) - Revenue Event Item - Debit Memo Item (Charge) - Debit Memo Item (Tax) - Credit Memo Item (Charge) - Credit Memo Item (Tax) - Credit Memo Application Item - Electronic Payment Application - External Payment Application - Electronic Refund Application - External Refund Application - Electronic Payment Application Item - External Payment Application Item - Electronic Refund Application Item - External Refund Application Item type: string required: - type title: transactionTypes type: object GETJournalRunType: properties: aggregateCurrency: description: '' type: boolean executedOn: description: | Date and time the journal run was executed. format: date-time type: string journalEntryDate: description: | Date of the journal entry. format: date type: string number: description: | Journal run number. type: string organizationLabels: description: | The organization(s) that the object belongs to. Note: This field is available only when the Multi-Org feature is enabled. items: properties: organizationId: description: | The organization ID. type: string organizationName: description: | The organization name. type: string type: object type: array segmentationRuleName: description: | Name of GL segmentation rule used in the journal run. type: string status: description: | Status of the journal run. enum: - Pending - Processing - Completed - Error - CancelInprogress - Cancelled - DeleteInprogress type: string success: description: | Returns `true` if the request was processed successfully. type: boolean targetEndDate: description: | The target end date of the journal run. format: date type: string targetStartDate: description: | The target start date of the journal run. format: date type: string totalJournalEntryCount: description: | Total number of journal entries in the journal run. format: int64 type: integer transactionTypes: description: | Transaction types included in the journal run. items: $ref: '#/components/schemas/GETJournalRunTransactionType' type: array type: object GETJournalRunTransactionType: properties: type: description: | Transaction type. Invoice Adjustment is deprecated on Production. Zuora recommends that you use the Invoice Item Adjustment instead. If you enable the Invoice Settlement feature, Debit Memo Item, Credit Memo Item, and Credit Memo Application Item are available, Payment and Refund will be replaced by Payment Application and Refund Application. If you enable both the Invoice Settlement feature and the Invoice Item Settlement feature, Payment and Refund will be replaced by Payment Application Item and Refund Application Item. enum: - Invoice Item - Taxation Item - Invoice Item Adjustment (Invoice) - Invoice Item Adjustment (Tax) - Invoice Adjustment - Electronic Payment - External Payment - Electronic Refund - External Refund - Electronic Credit Balance Payment - External Credit Balance Payment - Electronic Credit Balance Refund - External Credit Balance Refund - Credit Balance Adjustment (Applied from Credit Balance) - Credit Balance Adjustment (Transferred to Credit Balance) - Revenue Event Item - Debit Memo Item (Charge) - Debit Memo Item (Tax) - Credit Memo Item (Charge) - Credit Memo Item (Tax) - Credit Memo Application Item - Electronic Payment Application - External Payment Application - Electronic Refund Application - External Refund Application - Electronic Payment Application Item - External Payment Application Item - Electronic Refund Application Item - External Refund Application Item type: string title: transactionTypes type: object POSTMassUpdateResponseType: properties: bulkKey: description: | String of 32 characters that identifies the mass action. The bulkKey is generated before the mass action is processed. You can use the bulkKey to Get the Mass Action Result. type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETMassUpdateType: properties: actionType: description: | Type of mass action. type: string endedOn: description: | Date and time that the mass action was completed. The format is `yyyy-MM-dd hh:mm:ss`. format: date-time type: string errorCount: description: | Total number of failed records. This field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have failed so far. When the mass action **status** is Pending, this field is null. type: string inputSize: description: | Size of the input file in bytes. format: int64 type: integer outputSize: description: | Size of the response file in bytes. format: int64 type: integer outputType: description: | Type of output for the response file. The following table describes the output type. | Output Type | Description | |----------------|-------------------------------------| | (url:.csv.zip) | URL pointing to a zipped .csv file. | type: string outputURL: description: | URL to download the response file. The response file is a zipped .csv file. The response file is identical to the file you uploaded to perform the mass action, with additional columns providing information about the outcome of each record. This field only returns a value when the mass action **status** is Completed or Stopped. Otherwise, this field is null. type: string processedCount: description: | Total number of processed records. This field is equal to the sum of `errorCount` and `successCount`. This field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have been processed so far. When the mass action **status** is Pending, this field is null. type: string startedOn: description: | Date and time that Zuora started processing the mass action. The format is `yyyy-MM-dd hh:mm:ss`. format: date-time type: string status: description: | Status of the mass action. The following table describes the mass action statuses. | Status | Description | |------------|----------------------------------------------------------------------------| | Pending | Mass action has not yet started being processed. | | Processing | Mass action is in progress. | | Stopping | Mass action is in the process of stopping, but has not yet stopped. | | Stopped | Mass action has stopped. | | Completed | Mass action was successfully completed. There may still be failed records. | | Failed | Mass action failed. No records are processed. No response file is created. | type: string success: description: | Returns `true` if the request was processed successfully. type: boolean successCount: description: | Total number of successful records. This field is updated in real time. When the mass action **status** is Processing, this field returns the number of records that have succeeded so far. When the mass action **status** is Pending, this field is null. type: string totalCount: description: | Total number of records in the uploaded mass action file. When the mass action **status** is Pending, this field is null. type: string uploadedBy: description: | Email of the person who uploaded the mass action file. type: string uploadedOn: description: | Date and time that the mass action file was uploaded. The format is `yyyy-MM-dd hh:mm:ss`. format: date-time type: string type: object PostEventTriggerRequest: example: active: true baseObject: Invoice condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 eventType: name: LargeInvoicePosted displayName: Large Invoice Posted properties: active: description: The status of the event trigger. type: boolean baseObject: description: | The base object that the trigger rule 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`. maxLength: 100 minLength: 1 type: string condition: description: The JEXL expression to be evaluated against object changes. See above for more information and an example. maxLength: 5000 minLength: 1 type: string description: description: The description of the event trigger. maxLength: 1000 type: string eventType: $ref: '#/components/schemas/EventType' required: - baseObject - condition - eventType - active type: object EventTrigger: properties: active: description: The status of the trigger. type: boolean baseObject: description: | The base object that the trigger rule 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`. maxLength: 100 minLength: 1 type: string condition: description: The JEXL expression to be evaluated against object changes. See above for more information and an example. maxLength: 5000 minLength: 1 type: string description: description: The description of the trigger. maxLength: 1000 type: string eventType: $ref: '#/components/schemas/EventType' id: format: uuid type: string type: object EventType: properties: description: description: The description of the event type. maxLength: 1000 type: string displayName: description: The display name for the event type. maxLength: 500 minLength: 1 type: string name: description: 'The name of the event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$' maxLength: 200 minLength: 1 type: string required: - name - displayName type: object PutEventTriggerRequest: example: description: Trigger the event when an invoice is posted with amount over 1000 condition: changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0 properties: active: description: The status of the trigger. type: boolean condition: description: The JEXL expression to be evaluated against object changes. See above for more information and an example. maxLength: 5000 minLength: 1 type: string description: description: The description of the trigger. maxLength: 1000 type: string eventType: description: The type of events to be triggered. properties: description: description: The description for the event type. maxLength: 1000 type: string displayName: description: The display name for the event type. maxLength: 500 minLength: 1 type: string type: object type: object PostScheduledEventRequest: description: namespace.name pair should be unique universally example: active: true apiField: TermEndDate apiObject: Subscription condition: Subscription.Status == _SUBSCRIPTION_STATUS description: Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects. displayName: Term End Date Scheduled Event hours: 10 minutes: 30 name: TermEndDateScheduledEvent parameters: _SUBSCRIPTION_STATUS: description: The status of the subscription displayName: Subscription Status options: - Draft - Active - Pending - Expired - Cancelled valueType: STRING properties: active: default: true description: Indicate whether the scheduled event is active or inactive. type: boolean apiField: description: | The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\w\\-]*$ See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base fields. type: string apiObject: description: | The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$ See [Custom Scheduled Events](https://knowledgecenter.zuora.com/Central_Platform/Events_and_Notifications/A_Z_Custom_Scheduled_Events) for all available base objects. type: string condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition: ```Invoice.Amount > 1000.0``` `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. maxLength: 65535 type: string description: description: The description of the scheduled event. maxLength: 1000 type: string displayName: description: The display name of the scheduled event. maxLength: 500 minLength: 1 type: string hours: description: The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant. maximum: 23 minimum: 0 type: integer minutes: description: The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant. maximum: 59 minimum: 0 type: integer name: description: 'The name of the scheduled event. Should be unique, contain no space, and be in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$' maxLength: 200 minLength: 1 type: string parameters: additionalProperties: description: Definition of a filter rule parameter. properties: description: description: The description of the parameter. maxLength: 255 type: string displayName: description: The display name of the parameter. maxLength: 255 type: string options: description: The option values of the parameter. items: type: string type: array valueType: description: The type of the value. enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string type: object description: The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications. type: object required: - name - displayName - apiObject - apiField - hours - minutes type: object GetScheduledEventResponse: example: active: true apiField: TermEndDate apiObject: Subscription condition: Subscription.Status == _SUBSCRIPTION_STATUS cronExpression: 0 30 10 ? * * description: Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects. displayName: Term End Date Scheduled Event id: d306545b74e445e4bffcf1c7609804be name: TermEndDateScheduledEvent namespace: user.notification parameters: _SUBSCRIPTION_STATUS: description: The status of the subscription displayName: Subscription Status options: - Draft - Active - Pending - Expired - Cancelled valueType: STRING properties: active: description: Indicate whether the scheduled event is active or inactive type: boolean apiField: description: 'The base field of the base object in the `apiObject` field, should be in date or timestamp format. The scheduled event notifications are triggered based on this date and the event parameters (before or after a specified number of days) from notification definitions. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' type: string apiObject: description: 'The base object that the scheduled event is defined upon. The base object should contain a date or timestamp format field. Should be specified in the pattern: ^[A-Z][\\w\\-]*$' type: string condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition: ```Invoice.Amount > 1000.0``` `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. type: string cronExpression: description: The cron expression defines the time when scheduled event notifications will be sent. type: string description: description: The description of the scheduled event. type: string displayName: description: The display name of the scheduled event. type: string id: description: Scheduled event ID. format: uuid type: string name: description: The name of the scheduled event. type: string namespace: description: The namespace of the scheduled event name in the `name` field. type: string parameters: additionalProperties: description: Definition of a filter rule parameter. properties: description: description: The description of the parameter. maxLength: 255 type: string displayName: description: The display name of the parameter. maxLength: 255 type: string options: description: The option values of the parameter. items: type: string type: array valueType: description: The type of the value. type: string type: object description: The parameter definitions of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. You should specify all the parameters when creating scheduled event notifications. type: object title: ScheduledEvent type: object PutScheduledEventRequest: example: active: true condition: Subscription.Status == _SUBSCRIPTION_STATUS description: Trigger a scheduled event at 10:30 AM based on TermEndDate of subscription objects. displayName: Term End Date Scheduled Event hours: 10 minutes: 30 parameters: _SUBSCRIPTION_STATUS: description: The status of the subscription displayName: Subscription Status options: - Draft - Active - Pending - Expired - Cancelled valueType: STRING properties: active: description: Indicate whether the scheduled event is active or inactive type: boolean condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The scheduled event is triggered only if the condition is evaluated as true. The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Scheduled events with invalid merge fields will fail to evaluate, thus will not be triggered. For example, to trigger an invoice due date scheduled event to only invoices with an amount over 1000, you would define the following condition: ```Invoice.Amount > 1000.0``` `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. maxLength: 65535 type: string description: description: The description of the scheduled event. maxLength: 1000 type: string displayName: description: The display name of the scheduled event. maxLength: 500 minLength: 1 type: string hours: description: The scheduled time (hour) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant. maximum: 23 minimum: 0 type: integer minutes: description: The scheduled time (minute) that the scheduled event notifications are sent. This time is based on the localized timezone of your tenant. maximum: 59 minimum: 0 type: integer parameters: additionalProperties: description: Definition of a filter rule parameter. properties: description: description: The description of the parameter. maxLength: 255 type: string displayName: description: The display name of the parameter. maxLength: 255 type: string options: description: The option values of the parameter. items: type: string type: array valueType: description: The type of the value. enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string type: object description: The parameters of the filter rule. The names of the parameters must match with the filter rule and can't be duplicated. type: object type: object POSTPublicNotificationDefinitionRequest: properties: active: default: true description: The status of the notification definition. The default value is `true`. type: boolean associatedAccount: description: | The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. Available values are as follows: * `Account.Id`: ID of the primary customer account related to the notification. It is also the default value. * `ParentAccount.Id`: this option is available only if you have Customer Hierarchy enabled for your tenant. * `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action. **Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification. type: string callout: description: | If this field is specified, Zuora will create a new callout template when creating the notification definition and associate the template with the notification definition. You cannot specify the `calloutTemplateIds` and `callout` fields at the same time. For more information about callout templates, see Manage callout templates. oneOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutBasicAuthentication' - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutOauth2Authentication' calloutActive: default: false description: The status of the callout action. The default value is `false`. type: boolean calloutTemplateIds: description: | List of callout template IDs that the notification definition is associated with. You cannot specify the `calloutTemplateIds` and `callout` fields at the same time. For more information about callout templates, see Manage callout templates. items: type: string type: array communicationProfileId: description: | The ID of the communication profile that the notification definition is associated with. You can use the [Query Action](https://developer.zuora.com/api-references/api/operation/Action_POSTquery) to get the communication profile Id. See the following request sample: `{ "queryString": "select Id, ProfileName from CommunicationProfile" }` If you do not pass the communicationProfileId, notification service will be automatically added to the 'Default Profile'. If you want to associate the notification definition with multiple communication profiles, use the `communicationProfileIds` field, which overrides this field. type: string communicationProfileIds: description: | List of communication profile IDs that the notification definition is associated with. This field overrides the `communicationProfileId` field. items: type: string type: array description: description: The description of the notification definition. maxLength: 255 type: string emailActive: default: false description: The status of the email action. The default value is `false`. type: boolean emailTemplateId: description: The ID of the email template. If `emailActive` is `true`, an email template is required. And EventType of the email template MUST be the same as the eventType. format: uuid type: string eventCategory: description: | The event category code for a standard event, on which the notification definition is created. This field is required when creating notification definitions for standard events. For the list of supported standard event category codes, see Standard event category code for events and notifications. type: number eventTypeName: description: | The name of the event that the notification definition is based on. This field is required when creating notification definitions for Zuora custom events, custom events, or custom scheduled events. If this field is provided, you can specify the event namespace in the `eventTypeNamespace` field. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. For example, if you want to create a notification definition on the `OrderActionProcessed` event, which is a Zuora custom event, you must specify `com.zuora.notification` for this field. type: string enum: - user.notification - com.zuora.notification default: user.notification filterRule: description: '' properties: condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to filter an invoice posted notification to only invoices with an amount over 1000, you would define the following condition: ```Invoice.Amount > 1000.0``` There are conventions and keywords you need to be aware of. For example: * `Invoice.Amount` refers to the `Amount` field of the Zuora object `Invoice`. * Unlike Event Triggers, there is no access to variables with the `_old` suffix. Fields with the `_old` suffix are only available on Event Trigger conditions. example: Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS type: string description: description: The description of the filter rule. maxLength: 255 type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' required: - condition - parameters type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' name: description: The name of the notification definition, unique per communication profile. maxLength: 255 type: string required: - name type: object GETPublicNotificationDefinitionResponse: example: id: 838bfafa9b224408809f8ecbdae198ef createdBy: 8ad084a67f9c7138017fab8a8b511b5a createdOn: 2024-11-11T03:00:03.000 UTC updatedBy: 8ad084a67f9c7138017fab8a8b511b5a updatedOn: 2024-11-11T03:00:03.000 UTC eventTypeNamespace: user.notification eventTypeName: AccountEdit name: Account Edit Notification description: null communicationProfileId: 2c92c0f9446cd49501447539d6a72815 communicationProfileIds: - 2c92c0f9446cd49501447539d6a72815 active: true emailTemplateId: f11e498862584a10a05b83ea70119659 callout: null calloutTemplateIds: [] filterRule: id: a1efc8cc717e48208b9f0fd5d7bf2a58 createdBy: 8ad084a67f9c7138017fab8a8b511b5a createdOn: 2024-11-11T03:00:04.000 UTC updatedBy: null updatedOn: null description: Filter rule to test if an account is a VIP account condition: Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS parameters: _ACCOUNT_STATUS: displayName: VIP Account Status description: The status of the VIP Account options: - Draft - Active - Canceled valueType: STRING _VIP_BALANCE_AMOUNT: displayName: VIP Account Balance description: The minimum account balance options: null valueType: BIG_DECIMAL scheduled: false filterRuleParams: _ACCOUNT_STATUS: Active _VIP_BALANCE_AMOUNT: '100000.0' emailActive: true calloutActive: false associatedAccount: null properties: active: description: The status of the notification definition. The default value is `true`. type: boolean associatedAccount: description: | The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. type: string callout: properties: active: default: true description: The status of the callout. The default value is `true`. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' calloutBaseurl: description: The callout URL. It must start with 'https://' example: https://*** format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean description: description: Description for the callout. maxLength: 255 type: string eventTypeName: description: The name of the custom event type. minLength: 1 type: string httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string id: description: The ID of the callout. If `calloutActive` is `true`, a callout is required. The eventTypeName of the callout MUST be the same as the eventTypeName. format: uuid type: string name: description: The name of the created callout. maxLength: 255 type: string oauth2ProviderId: description: The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. type: string requiredAuth: description: Indicates whether Basic authentication is enabled for the callout. type: boolean requiredOauth2: description: Indicates whether OAuth 2.0 authentication is enabled for the callout. type: boolean type: object calloutActive: description: The status of the callout action. The default value is `false`. type: boolean calloutTemplateIds: description: | List of callout template IDs that the notification definition is associated with. items: type: string type: array communicationProfileId: description: | The ID of the communication profile that the notification definition is associated with. If the notification definition is associated with multiple communication profiles, see `communicationProfileIds` for all associated communication profile IDs. format: uuid type: string communicationProfileIds: description: | List of communication profile IDs that the notification definition is associated with. items: type: string type: array createdBy: description: The ID of the user who created the notification definition. format: uuid type: string createdOn: description: The time when the notification definition was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string description: description: Description of the notification definition maxLength: 255 type: string emailActive: description: The status of the email action. The default value is `false`. type: boolean emailTemplateId: description: The ID of the email template. In the request, there should be at least one email template or callout. format: uuid type: string eventCategory: description: | The event category code for a standard event, on which the notification definition is created. This field is available only if the notification definition is based on a standard event. For the list of supported standard event category codes, see Standard event category code for events and notifications. type: number eventId: description: | The ID of the event that the notification definition is based on. This field is available only if the notification definition is based on a standard event. type: string format: uuid eventTypeName: description: | The name of the event that the notification definition is based on. This field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This field is available only if the notification definition is based on a Zuora custom event, custom event, or custom scheduled event. type: string enum: - user.notification - com.zuora.notification filterRule: description: '' properties: condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object: ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0``` There are conventions and keywords you need to be aware of. For example: * `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `DELETE`. * `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`. * A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The "_old" fields are only available on the base objects. example: Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS type: string description: description: The description of the filter rule. maxLength: 255 type: string eventTypeName: description: The value is `null`. minLength: 1 type: string id: description: The ID of the filter rule. If not specified or null, the notification definition is always qualified to process events of "eventType". format: uuid type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' id: description: The ID associated with this notification definition. format: uuid type: string name: description: The name of the notification definition. maxLength: 255 type: string updatedBy: description: The ID of the user who updated the notification definition. format: uuid type: string updatedOn: description: The time when the notification was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string type: object CalloutAuth: description: If `requiredAuth` is `true`, this object is required. properties: domain: description: The domain of the callout auth. type: string password: description: The field is required when `requiredAuth` is `true`. type: string preemptive: description: Set this field to `true` if you want to enable the preemptive authentication. type: boolean username: description: The field is required when `requiredAuth` is `true`. type: string type: object nullable: true CalloutMergeFields: additionalProperties: description: | The key is the parameter name. The value is a merge field with angle brackets. type: string description: | A key-value map of merge fields of this callout. title: calloutParams type: object FilterRuleParameterDefinitions: additionalProperties: $ref: '#/components/schemas/FilterRuleParameterDefinition' description: | The parameters of the filter rule and their name must match those in the filter rule. And all parameters must be defined in the event type payload. The name of parameters can't be duplicate. The following reserved keywords should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY` title: parameters type: object FilterRuleParameterValues: additionalProperties: description: | The following reserved key words should not be used as a parameter name: `AttachmentList`, `RecipientList`, `RecipientType`, `Exceptions`, `OCP_OBJECT_TYPE`, `OCP_OBJECT_ID`, `OCP_TRIGGER_BY`. `Include.Attachment` is a special boolean parameter. By specifying this parameter, you can tell a notification whose event type is based on Invoice to include attachments while sending emails. type: string description: | The parameter values used to configure the filter rule. title: filterRuleParams type: object FilterRuleParameterDefinition: description: | Definition of a filter rule parameter. properties: description: maxLength: 255 type: string displayName: description: | The display name of the parameter. maxLength: 255 type: string options: description: | The option values of the parameter. items: type: string type: array valueType: description: | The type of the value. enum: - STRING - BYTE - SHORT - CHARACTER - INTEGER - LONG - FLOAT - DOUBLE - BOOLEAN - BIG_INTEGER - BIG_DECIMAL - LOCAL_DATE - LOCAL_DATE_TIME - TIMESTAMP - BYTE_ARRAY - SHORT_ARRAY - CHARACTER_ARRAY - INTEGER_ARRAY - FLOAT_ARRAY - DOUBLE_ARRAY - BOOLEAN_ARRAY - STRING_ARRAY - BIG_INTEGER_ARRAY - BIG_DECIMAL_ARRAY - LOCAL_DATE_ARRAY - LOCAL_DATE_TIME_ARRAY - TIMESTAMP_ARRAY type: string title: parameter type: object POSTPublicNotificationDefinitionCalloutCommon: title: Callout - without authentication description: | Common information for callout notifications. properties: active: default: true description: The status of the callout. The default is `true`. type: boolean calloutBaseurl: description: | The callout URL. It must start with 'https://'. Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at Zuora Global Support. example: https://*** format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean description: description: Description for the callout. maxLength: 255 type: string eventTypeName: description: The name of the event type. The value must be the same as the parent-level `eventTypeName` field. minLength: 1 type: string httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string name: description: The name of the callout template that will be created. It must be unique across all callout templates. maxLength: 255 type: string required: - name - calloutBaseurl - httpMethod type: object POSTPublicNotificationDefinitionCalloutBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - type: object description: | The Basic Authentication information for callout notifications. properties: requiredAuth: description: | Indicates whether Basic authentication is enabled for the callout. When creating callout notifications with Basic authentication enabled, you must set this field to `true` and specify the username and password in `calloutAuth`. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' required: - requiredAuth POSTPublicNotificationDefinitionCalloutOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTPublicNotificationDefinitionCalloutCommon' - type: object description: | The OAuth 2.0 Authentication information for callout notifications. properties: requiredOauth2: description: | Indicates whether OAuth 2.0 authentication is enabled for the callout. When creating callout notifications with OAuth 2.0 authentication enabled, you must set this field to `true` and specify the OAuth 2.0 provider ID in `oauth2ProviderId`. type: boolean oauth2ProviderId: description: | The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if `requiredOauth2` is `true`. For more information about how to get the ID of an OAuth 2.0 provider, see Retrieve the ID of an OAuth 2.0 provider. required: - requiredOauth2 PUTPublicNotificationDefinitionRequest: example: description: Details of the notification definition properties: active: default: true description: The status of the notification definition. The default value is `true`. type: boolean associatedAccount: description: | The account on which the histories of this notification will be displayed. The associated account does not enforce where the merge fields come from. Available values are as follows: * `Account.Id`: ID of the primary customer account related to the notification. It is also the default value. * `ParentAccount.Id`: this option is available only if you have Customer Hierarchy enabled for your tenant. * `SubscriptionOwnerAccount.Id`: this option is available if the base object of the notification is Order Action. **Note:** before specifying this field, we recommend that you use [Data Source](https://knowledgecenter.zuora.com/Billing/Reporting/D_Data_Sources_and_Exports/C_Data_Source_Reference) to check the available types of accounts for the current notification. type: string callout: description: | If this field is specified, Zuora will create a new callout template when creating the notification definition and associate the template with the notification definition. You cannot specify the `calloutTemplateIds` and `callout` fields at the same time. For more information about callout templates, see Manage callout templates. oneOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutBasicAuthentication' - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutOauth2Authentication' calloutActive: default: false description: The status of the callout action. The default value is `false`. type: boolean calloutTemplateIds: description: | List of callout template IDs that the notification definition is associated with. You cannot specify the `calloutTemplateIds` and `callout` fields at the same time. For more information about callout templates, see Manage callout templates. items: type: string type: array communicationProfileId: description: | The profile that notification definition belongs to. If you want to associate the notification definition with multiple communication profiles, use the `communicationProfileIds` field, which overrides this field. format: uuid type: string communicationProfileIds: description: | List of communication profile IDs that the notification definition is associated with. This field overrides the `communicationProfileId` field. items: type: string type: array description: description: The description of the notification definition. maxLength: 255 type: string emailActive: default: false description: The status of the email action. The default value is `false`. type: boolean emailTemplateId: description: | The ID of the email template. If emailActive is updated from false to true, an email template is required, and the EventType of the email template MUST be the same as the EventType of the notification definition. format: uuid type: string filterRule: description: '' properties: condition: description: | The filter rule conditions, written in [JEXL](http://commons.apache.org/proper/commons-jexl/). The rule might contain event context merge fields and data source merge fields. Data source merge fields must be from [the base object of the event or from the joined objects of the base object](https://knowledgecenter.zuora.com/DC_Developers/M_Export_ZOQL#Data_Sources_and_Objects). Notifications with invalid merge fields will fail to evaluate, thus will not be invoked. For example, to trigger an event when an invoice is posted with the amount over 1000, you would define the following condition on the `Invoice` object: ```changeType == 'UPDATE' && Invoice.Status == 'Posted' && Invoice.Status_old != 'Posted' && Invoice.Amount > 1000.0``` There are conventions and keywords you need to be aware of. For example: * `changeType` is a keyword to specify what kind of change happened to the object. Allowed values are `INSERT`, `UPDATE` or `DELETE`. * `Invoice.Status` refers to field `Status` of the Zuora object `Invoice`. * A variable with the `_old` suffix means it’s a previous value of the corresponding object field. The "_old" fields are only available on the base objects. example: Account.Balance >= _VIP_BALANCE_AMOUNT && Account.Status == _ACCOUNT_STATUS type: string description: description: The description of the filter rule. maxLength: 255 type: string parameters: $ref: '#/components/schemas/FilterRuleParameterDefinitions' required: - eventTypeName - condition - parameters type: object filterRuleParams: $ref: '#/components/schemas/FilterRuleParameterValues' name: description: The name of the notification definition, which is unique in the profile. maxLength: 255 type: string type: object PUTPublicNotificationDefinitionCalloutCommon: title: Callout - without authentication description: | Common information for callout notifications. properties: active: default: true description: The status of the callout. The default value is `true`. type: boolean calloutBaseurl: description: | The callout URL. It must start with 'https://'. Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at Zuora Global Support. example: https://*** format: url minLength: 10 type: string calloutParams: $ref: '#/components/schemas/CalloutMergeFields' calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean description: description: Description for the callout. maxLength: 255 type: string httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string name: description: The name of the callout template that will be created. It must be unique across all callout templates. maxLength: 255 type: string type: object PUTPublicNotificationDefinitionCalloutBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - type: object description: | The Basic Authentication information for callout notifications. properties: requiredAuth: description: | Indicates whether Basic authentication is enabled for the callout. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' PUTPublicNotificationDefinitionCalloutOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/PUTPublicNotificationDefinitionCalloutCommon' - type: object description: | The OAuth 2.0 Authentication information for callout notifications. properties: requiredOauth2: description: | Indicates whether OAuth 2.0 authentication is enabled for the callout. type: boolean oauth2ProviderId: description: | The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. For more information about how to get the ID of an OAuth 2.0 provider, see Retrieve the ID of an OAuth 2.0 provider. POSTCreateOrUpdateEmailTemplateRequest: properties: allowPartialSuccess: description: | When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all email templates have been successfully updated. When set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response. type: boolean emailTemplates: description: | A container for email templates. items: $ref: '#/components/schemas/POSTCreateOrUpdateEmailTemplateRequestFormat' type: array type: object CreateOrUpdateEmailTemplatesResponse: example: reasons: [] properties: reasons: description: | Returns an empty array if the request succeeds. items: type: string type: array type: object POSTCreateOrUpdateEmailTemplateRequestFormat: properties: active: default: true description: The status of the email template. The default value is `true`. type: boolean bccEmailAddress: description: The email bcc address. format: email type: string ccEmailAddress: description: The email CC address. type: string ccEmailType: default: SpecificEmails description: | Email CC type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string description: description: The description of the email template. maxLength: 255 type: string emailBody: description: | The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. You can also embed HTML tags if `isHtml` is `true`. type: string emailHeaders: type: object title: emailHeader description: | Container for custom email headers. Each custom email header consists of a header name and a header value. additionalProperties: type: string description: | The custom email header consists of a name-value pair: * Field name: the name of the custom email header. * Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see Merge field syntax for email templates. emailSubject: description: | The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. type: string encodingType: default: UTF8 description: The endcode type of the email body. enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: description: | If you specify this field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes. type: number eventTypeName: description: | The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event. type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default. Note that if the `eventTypeName` is a standard event type, you must specify the `com.zuora.notification` namespace; otherwise, you will get an error. For example, if you want to create an email template on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field. type: string fromEmailAddress: description: If fromEmailType is SpecificEmail, this field is required. type: string fromEmailType: description: The type of the email. enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: description: The name of the email sender. type: string id: description: | ID of an existing email template. Specify this field if you want to update an existing email template. type: string isHtml: default: false description: Indicates whether the style of email body is HTML. The default value is `false`. type: boolean name: description: The name of the email template, a unique name in a tenant. maxLength: 255 type: string replyToEmailAddress: description: If `replyToEmailType` is `SpecificEmail`, this field is required. type: string replyToEmailType: description: Type of the replyTo email. enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: description: If toEmailType is SpecificEmail, this field is required. type: string toEmailType: description: | Email receive type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string required: - name - fromEmailType - emailSubject - emailBody - toEmailType type: object POSTPublicEmailTemplateRequest: example: name: Account Edit Email eventTypeName: AccountEdit active: true fromName: Company Co. Ltd. fromEmailType: TenantEmail toEmailType: BillToContact replyToEmailType: TenantEmail emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited emailBody: Dear user,

the account {{DataSource.Account.AccountNumber}} has been edited.

Company Co. Ltd. properties: active: default: true description: The status of the email template. The default value is `true`. type: boolean bccEmailAddress: description: The email bcc address. format: email type: string ccEmailAddress: description: The email CC address. type: string ccEmailType: default: SpecificEmails description: | Email CC type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string description: description: The description of the email template. maxLength: 255 type: string emailBody: description: | The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. You can also embed HTML tags if `isHtml` is `true`. type: string emailHeaders: type: object title: emailHeader description: | Container for custom email headers. Each custom email header consists of a header name and a header value. additionalProperties: type: string description: | The custom email header consists of a name-value pair: * Field name: the name of the custom email header. * Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see Merge field syntax for email templates. emailSubject: description: | The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. type: string encodingType: default: UTF8 description: The endcode type of the email body. enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: description: | If you specify this field, the email template is created based on a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all standard event category codes. type: number eventTypeName: description: | The name of the custom event or custom scheduled event. If you specify this field, the email template is created based on the corresponding custom event or custom scheduled event. type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. The `eventTypeName` has the `user.notification` namespace by default. Note that if the `eventTypeName` is a standard event type, you must specify the `com.zuora.notification` namespace; otherwise, you will get an error. For example, if you want to create an email template on the `OrderActionProcessed` event, you must specify `com.zuora.notification` for this field. type: string fromEmailAddress: description: If fromEmailType is SpecificEmail, this field is required. type: string fromEmailType: description: The type of the email. enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: description: The name of the email sender. type: string isHtml: default: false description: Indicates whether the style of email body is HTML. The default value is `false`. type: boolean name: description: The name of the email template, a unique name in a tenant. maxLength: 255 type: string replyToEmailAddress: description: If replyToEmailType is SpecificEmail, this field is required. type: string replyToEmailType: description: Type of the replyTo email. enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: description: If toEmailType is SpecificEmail, this field is required. type: string toEmailType: description: | Email receive type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string required: - name - fromEmailType - emailSubject - emailBody - toEmailType type: object GETPublicEmailTemplateResponse: example: id: f11e498862584a10a05b83ea70119659 createdBy: 8ad084a67f9c7138017fab8a8b511b5a createdOn: 2024-11-06T09:24:07.000 UTC updatedBy: 8ad084a67f9c7138017fab8a8b511b5a updatedOn: 2024-11-06T09:24:07.000 UTC eventTypeNamespace: user.notification eventTypeName: AccountEdit name: Account Edit Email description: '' encodingType: UTF8 fromName: Company Co. Ltd. fromEmailType: TenantEmail fromEmailAddress: '' replyToEmailType: TenantEmail replyToEmailAddress: '' ccEmailType: SpecificEmails ccEmailAddress: '' bccEmailAddress: '' toEmailType: BillToContact toEmailAddress: '' emailHeaders: {} emailSubject: Account {{DataSource.Account.AccountNumber}} has been edited emailBody: Dear user,

the account {{DataSource.Account.AccountNumber}} has been edited.

Company Co. Ltd. fileId: '' active: true isHtml: false useAdditionalAddresses: false properties: active: description: The status of the email template. type: boolean bccEmailAddress: description: Email BCC address. format: email type: string ccEmailAddress: description: Email CC address. type: string ccEmailType: default: SpecificEmails description: Email cc type. enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string createdBy: description: The ID of the user who created the email template. format: uuid type: string createdOn: description: The time when the email template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string description: description: The description of the email template. maxLength: 255 type: string emailBody: description: | The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. User can also embed html tags if `isHtml` is `true`. type: string emailHeaders: type: object title: emailHeader description: | Container for custom email headers. Each custom email header consists of a header name and a header value. additionalProperties: type: string description: | The custom email header consists of a name-value pair: * Field name: the name of the custom email header. * Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see Merge field syntax for email templates. emailSubject: description: | The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. type: string encodingType: description: The endcode type of the email body. enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string eventCategory: description: The event category code for a standard event. See [Standard Event Categories](https://knowledgecenter.zuora.com/Central_Platform/Notifications/A_Standard_Events/Standard_Event_Category_Code_for_Notification_Histories_API) for all event category codes. type: number eventTypeName: description: The name of the custom event or custom scheduled event. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field for custom events and custom scheduled events. type: string fromEmailAddress: description: If formEmailType is SpecificEmail, this field is required. type: string fromEmailType: description: The from email type. enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: description: The name of email sender. maxLength: 50 type: string id: description: The email template ID. format: uuid type: string isHtml: description: Indicates whether the style of email body is HTML. type: boolean name: description: The name of the email template. maxLength: 255 type: string replyToEmailAddress: description: If replyToEmailType is SpecificEmail, this field is required type: string replyToEmailType: description: The reply email type. enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: description: If `toEmailType` is `SpecificEmail`, this field is required. type: string toEmailType: description: Email receive type. enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string updatedBy: description: The ID of the user who updated the email template. format: uuid type: string updatedOn: description: The time when the email template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string type: object PUTPublicEmailTemplateRequest: example: description: Details of the email template properties: active: description: The status of the email template. type: boolean bccEmailAddress: description: Email bcc address. format: email type: string ccEmailAddress: description: Email cc address. type: string ccEmailType: default: SpecificEmails description: | Email CC type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string description: description: The description of the email template. maxLength: 255 type: string emailBody: description: | The email body. You can add merge fields in the email body using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. User can also embed html tags if `isHtml` is `true`. type: string emailHeaders: type: object title: emailHeader description: | Container for custom email headers. Each custom email header consists of a header name and a header value. additionalProperties: type: string description: | The custom email header consists of a name-value pair: * Field name: the name of the custom email header. * Field value: the value of the custom email header. You can add merge fields in the field value. For more information, see Merge field syntax for email templates. emailSubject: description: | The email subject. You can add merge fields in the email subject using angle brackets or double curly brackets. For more information, see Merge field syntax for email templates. type: string encodingType: description: The endcode type of the email body. enum: - UTF8 - Shift_JIS - ISO_2022_JP - EUC_JP - X_SJIS_0213 type: string fromEmailAddress: description: If fromEmailType is SpecificEmail, this field is required type: string fromEmailType: description: The type of fromEmail. enum: - TenantEmail - RunOwner - SpecificEmail type: string fromName: description: The name of email sender. type: string isHtml: description: Indicates whether the style of email body is HTML. type: boolean name: description: The name of the email template. maxLength: 255 type: string replyToEmailAddress: description: If replyToEmailType is SpecificEmail, this field is required. type: string replyToEmailType: description: The type of the reply email. enum: - TenantEmail - RunOwner - SpecificEmail type: string toEmailAddress: description: If toEmailType is SpecificEmail, this field is required. type: string toEmailType: description: |- Email receive type. - When the related event is account-level and associated with the Subscription object, such as Subscription Created, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts - When the related event is account-level and not associated with the Subscription object, such as Payment Processed, you can use the following values: - BillToContact - SoldToContact - ShipToContact - BillToAndSoldToContacts - AllContacts - SpecificEmails - When the related event is tenant-level, such as Bill Run Completion, you can use the following values: - TenantAdmin - RunOwner - SpecificEmails enum: - BillToContact - SoldToContact - ShipToContact - SpecificEmails - TenantAdmin - BillToAndSoldToContacts - RunOwner - AllContacts - InvoiceOwnerBillToContact - InvoiceOwnerSoldToContact - InvoiceOwnerShipToContact - InvoiceOwnerBillToAndSoldToContacts - InvoiceOwnerAllContacts type: string type: object POSTCreateOrUpdateCalloutTemplateRequest: example: allowPartialSuccess: true calloutTemplates: - name: Account Edit eventTypeName: AccountEdit calloutBaseurl: https://www.example.com/callout/AccountEdit httpMethod: POST - name: Account Delete eventTypeName: AccountDelete calloutBaseurl: https://www.example.com/callout/AccountDelete httpMethod: POST properties: allowPartialSuccess: description: | When set to `false`, the call will fail if one or multiple instances fail to import, and a `200` response is returned if all callout templates have been successfully updated. When set to `true`, a success (`200`) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response. type: boolean calloutTemplates: description: | A container for callout templates. items: oneOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication' type: array type: object POSTCreateOrUpdateCalloutTemplateRequestCommon: title: Callout - without authentication description: | Common information for callout templates. properties: active: default: true description: The status of the callout. The default is `true`. type: boolean calloutBaseurl: description: | The callout URL. It must start with `https://`. Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at Zuora Global Support. You can add merge fields in the callout URL. For example, `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more information, see Merge field syntax for email and callout templates. example: https://*** format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader description: | Container for custom callout headers. Each custom callout header consists of a header name and a header value. additionalProperties: type: string description: | The custom callout header consists of a key-value pair: * Field key: the name of the custom callout header. * Field value: the value of the custom callout header. You can add merge fields in the field name or value. For more information, see Merge field syntax for email and callout templates. calloutParams: type: object title: calloutParameter description: | Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value. additionalProperties: type: string description: | The callout parameter consists of a key-value pair: * Field key: the name of the callout parameter. * Field value: the value of the callout parameter. You can add merge fields in the field name or value. For example, `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For more information, see Merge field syntax for email and callout templates. Alternatively, you can use the `customRequestBody` field for JSON-formatted callout parameters sent in the callout body. calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean certificate: type: string description: | The SSL certificate for the domain of the callout receiver server specified in `calloutBaseurl`. The value must be in PEM format, which typically starts with `-----BEGIN CERTIFICATE-----` and ends with `-----END CERTIFICATE-----`. Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications. customRequestBody: type: string description: | Customized request body. This field is available only for callouts whose Content-Type in the request body is `application/json`. The value must be in JSON format and double quotes in the value must be escaped. You can add merge fields to the request body. For example, `{\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\",\"AccountId\": \"{{DataSource.Account.Id}}\"}`. For more information, see Merge field syntax for email and callout templates. You must set `useCustomRequestBody` to `true` if you want to customize the callout request body with this field. Alternatively, you can use the `calloutParams` field. description: description: Description for the callout template. maxLength: 255 type: string eventCategory: description: | The event category code for a standard event that the callout template relates to. This field is required when creating callout templates for standard events. For the list of supported standard event category codes, see Standard event category code for events and notifications. type: number eventTypeName: description: | The name of a custom event that the callout template relates to. This field is required when creating callout templates for Zuora custom events, custom events, or custom scheduled events. If this field is provided, you can specify the event namespace in the `eventTypeNamespace` field. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. For example, if you want to create a callout template that relates to the `OrderActionProcessed` event, which is a Zuora custom event, you must specify `com.zuora.notification` for this field. type: string enum: - user.notification - com.zuora.notification default: user.notification hmacAlgorithm: type: string description: | The hash function Zuora uses to generate the signed data for HMAC authentication. enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string description: | The message to be authenticated for HMAC authentication. You can use merge fields in this value: - `{{Request.Headers.}}`: Refers to the value of a particular request header. For example, `{{Request.Headers.Date}}` refers to the value of the request header called `Date`. - `{{Request.Body}}`: Refers to the request body. - Other merge fields: See Merge field syntax for email and callout templates. hmacKey: type: string description: | The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the `hmacValue` field and typically contains the signed data. hmacOutputFormat: type: string description: | The format of the signed data for HMAC authentication. enum: - BASE64 - HEX hmacSecret: type: string description: | The shared secret key that Zuora uses to generate the signed data for HMAC authentication. hmacValue: type: string description: | The header value for HMAC authentication. The header key is specified in the `hmacKey` field. You can use merge fields in this value: - `{{Request.HMAC.Signed}}`: Refers to the signed data. - Other merge fields: See Merge field syntax for email and callout templates. The following is a header value example: `The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}`. httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string id: description: | ID of an existing callout template. Specify this field if you want to update an existing callout template. type: string name: description: The name of the callout template. It must be unique across all callout templates. maxLength: 255 type: string useCustomRequestBody: type: boolean description: | Indicates whether to enable the customized request body configured in the `customRequestBody` field. required: - name - calloutBaseurl - httpMethod type: object POSTCreateOrUpdateCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - type: object description: | The Basic Authentication information for callout notifications. properties: requiredAuth: description: | Indicates whether Basic authentication is enabled for the callout. When creating callout notifications with Basic authentication enabled, you must set this field to `true` and specify the username and password in `calloutAuth`. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' POSTCreateOrUpdateCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTCreateOrUpdateCalloutTemplateRequestCommon' - type: object description: | The OAuth 2.0 Authentication information for callout notifications. properties: requiredOauth2: description: | Indicates whether OAuth 2.0 authentication is enabled for the callout. When creating callout notifications with OAuth 2.0 authentication enabled, you must set this field to `true` and specify the OAuth 2.0 provider ID in `oauth2ProviderId`. type: boolean oauth2ProviderId: description: | The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if `requiredOauth2` is `true`. For more information about how to get the ID of an OAuth 2.0 provider, see Retrieve the ID of an OAuth 2.0 provider. POSTPublicCalloutTemplateRequest: oneOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestOauth2Authentication' GETPublicCalloutTemplateResponse: properties: active: description: The status of the callout template. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' calloutBaseurl: description: The callout URL. example: https://*** format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader description: | Container for custom callout headers. Each custom callout header consists of a header name and a header value. additionalProperties: type: string description: | The custom callout header consists of a key-value pair: * Field name: the name of the custom callout header. * Field value: the value of the custom callout header. You can add merge fields in the field name or value. For more information, see Merge field syntax for email and callout templates. nullable: true calloutParams: type: object title: calloutParameter description: | Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value. additionalProperties: type: string description: | The callout parameter consists of a key-value pair: * Field key: the name of the callout parameter. * Field value: the value of the callout parameter. You can add merge fields in the field name or value. For example, `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For more information, see Merge field syntax for email and callout templates. nullable: true calloutRetry: description: Indicates whether to retry the callout when the callout fails. type: boolean certificate: type: string nullable: true description: | The SSL certificate for the domain of the callout receiver server specified in `calloutBaseurl`. contentType: type: string description: The callout body format. createdBy: description: The ID of the user who created the callout template. format: uuid type: string createdOn: description: The time when the callout template was created. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string customRequestBody: type: string description: | Customized request body. nullable: true description: description: Description for the callout template. maxLength: 255 type: string eventCategory: description: | The event category code for the standard event that the callout template relates to. This field is available only if the related event of this callout template is a standard event. For the list of supported standard event category codes, see Standard event category code for events and notifications. type: number eventTypeName: description: | The name of the custom event that the callout template relates to. This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. This field is available only if the related event of this callout template is a Zuora custom event, custom event, or custom scheduled event. type: string enum: - user.notification - com.zuora.notification hmacAlgorithm: type: string nullable: true description: | The hash function Zuora uses to generate the signed data for HMAC authentication. enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 - null hmacData: type: string nullable: true description: | The message to be authenticated for HMAC authentication. hmacKey: type: string nullable: true description: | The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the `hmacValue` field and typically contains the signed data. hmacOutputFormat: type: string nullable: true description: | The format of the signed data for HMAC authentication. enum: - BASE64 - HEX - null hmacSecret: type: string nullable: true description: | The shared secret key that Zuora uses to generate the signed data for HMAC authentication. hmacValue: type: string nullable: true description: | The header value for HMAC authentication. The header key is specified in the `hmacKey` field. httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string id: description: | The ID of the callout template. format: uuid type: string name: description: The name of the callout template. maxLength: 255 type: string oauth2ProviderId: description: The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. type: string nullable: true requiredAuth: description: Indicates whether Basic authentication is enabled for the callout. type: boolean requiredOauth2: description: Indicates whether OAuth 2.0 authentication is enabled for the callout. type: boolean updatedBy: description: The ID of the user who updated the callout template. format: uuid type: string updatedOn: description: The time when the callout template was updated. Specified in the UTC timezone in the ISO860 format (YYYY-MM-DDThh:mm:ss.sTZD). E.g. 1997-07-16T19:20:30.45+00:00 format: date-time type: string useCustomRequestBody: type: boolean description: | Indicates whether to enable the customized request body configured in the `customRequestBody` field. type: object POSTPublicCalloutTemplateRequestCommon: title: Callout - without authentication description: | Common information for callout templates. properties: active: default: true description: The status of the callout. The default is `true`. type: boolean calloutBaseurl: description: | The callout URL. It must start with `https://`. Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at Zuora Global Support. You can add merge fields in the callout URL. For example, `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more information, see Merge field syntax for email and callout templates. example: https://*** format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader description: | Container for custom callout headers. Each custom callout header consists of a header name and a header value. additionalProperties: type: string description: | The custom callout header consists of a key-value pair: * Field key: the name of the custom callout header. * Field value: the value of the custom callout header. You can add merge fields in the field name or value. For more information, see Merge field syntax for email and callout templates. calloutParams: type: object title: calloutParameter description: | Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value. additionalProperties: type: string description: | The callout parameter consists of a key-value pair: * Field key: the name of the callout parameter. * Field value: the value of the callout parameter. You can add merge fields in the field name or value. For example, `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For more information, see Merge field syntax for email and callout templates. Alternatively, you can use the `customRequestBody` field for JSON-formatted callout parameters sent in the callout body. calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean certificate: type: string description: | The SSL certificate for the domain of the callout receiver server specified in `calloutBaseurl`. The value must be in PEM format, which typically starts with `-----BEGIN CERTIFICATE-----` and ends with `-----END CERTIFICATE-----`. Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications. customRequestBody: type: string description: | Customized request body. This field is available only for callouts whose Content-Type in the request body is `application/json`. The value must be in JSON format and double quotes in the value must be escaped. You can add merge fields to the request body. For example, `{\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\",\"AccountId\": \"{{DataSource.Account.Id}}\"}`. For more information, see Merge field syntax for email and callout templates. You must set `useCustomRequestBody` to `true` if you want to customize the callout request body with this field. Alternatively, you can use the `calloutParams` field. description: description: Description for the callout template. maxLength: 255 type: string eventCategory: description: | The event category code for a standard event that the callout template relates to. This field is required when creating callout templates for standard events. For the list of supported standard event category codes, see Standard event category code for events and notifications. type: number eventTypeName: description: | The name of a custom event that the callout template relates to. This field is required when creating callout templates for Zuora custom events, custom events, or custom scheduled events. If this field is provided, you can specify the event namespace in the `eventTypeNamespace` field. minLength: 1 type: string eventTypeNamespace: description: | The namespace of the `eventTypeName` field. It indicates who created the event and which namespace the event is assigned to. Supported values are as follows: - `com.zuora.notification`: events that are created by Zuora. This value applies to Zuora custom events. - `user.notification`: events that are created by tenant users. This value applies to custom events and custom scheduled events. This is the default value. For example, if you want to create a callout template that relates to the `OrderActionProcessed` event, which is a Zuora custom event, you must specify `com.zuora.notification` for this field. type: string enum: - user.notification - com.zuora.notification default: user.notification hmacAlgorithm: type: string description: | The hash function Zuora uses to generate the signed data for HMAC authentication. enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string description: | The message to be authenticated for HMAC authentication. You can use merge fields in this value: - `{{Request.Headers.}}`: Refers to the value of a particular request header. For example, `{{Request.Headers.Date}}` refers to the value of the request header called `Date`. - `{{Request.Body}}`: Refers to the request body. - Other merge fields: See Merge field syntax for email and callout templates. hmacKey: type: string description: | The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the `hmacValue` field and typically contains the signed data. hmacOutputFormat: type: string description: | The format of the signed data for HMAC authentication. enum: - BASE64 - HEX hmacSecret: type: string description: | The shared secret key that Zuora uses to generate the signed data for HMAC authentication. hmacValue: type: string description: | The header value for HMAC authentication. The header key is specified in the `hmacKey` field. You can use merge fields in this value: - `{{Request.HMAC.Signed}}`: Refers to the signed data. - Other merge fields: See Merge field syntax for email and callout templates. The following is a header value example: `The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}`. httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string name: description: The name of the callout template. It must be unique across all callout templates. maxLength: 255 type: string useCustomRequestBody: type: boolean description: | Indicates whether to enable the customized request body configured in the `customRequestBody` field. required: - name - calloutBaseurl - httpMethod type: object POSTPublicCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - type: object description: | The Basic Authentication information for callout templates. properties: requiredAuth: description: | Indicates whether Basic authentication is enabled for the callout. When creating callout templates with Basic authentication enabled, you must set this field to `true` and specify the username and password in `calloutAuth`. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' required: - requiredAuth POSTPublicCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/POSTPublicCalloutTemplateRequestCommon' - type: object description: | The OAuth 2.0 Authentication information for callout templates. properties: requiredOauth2: description: | Indicates whether OAuth 2.0 authentication is enabled for the callout. When creating callout templates with OAuth 2.0 authentication enabled, you must set this field to `true` and specify the OAuth 2.0 provider ID in `oauth2ProviderId`. type: boolean oauth2ProviderId: description: | The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. This field is required if `requiredOauth2` is `true`. For more information about how to get the ID of an OAuth 2.0 provider, see Retrieve the ID of an OAuth 2.0 provider. required: - requiredOauth2 PUTPublicCalloutTemplateRequest: oneOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestBasicAuthentication' - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestOauth2Authentication' PUTPublicCalloutTemplateRequestCommon: title: Callout - without authentication description: | Common information for callout templates. properties: active: default: true description: The status of the callout. type: boolean calloutBaseurl: description: | The callout URL. It must start with `https://`. Zuora uses port 443 to send callout notifications by default. If you want to use other ports, submit a request at Zuora Global Support. You can add merge fields in the callout URL. For example, `https://mywebsite.com/zuora/{{DataSource.Account.Id}}`. For more information, see Merge field syntax for email and callout templates. example: https://*** format: url minLength: 10 type: string calloutHeaders: type: object title: calloutHeader description: | Container for custom callout headers. Each custom callout header consists of a header name and a header value. additionalProperties: type: string description: | The custom callout header consists of a key-value pair: * Field key: the name of the custom callout header. * Field value: the value of the custom callout header. You can add merge fields in the field name or value. For more information, see Merge field syntax for email and callout templates. calloutParams: type: object title: calloutParameter description: | Container for callout parameters sent in the request body. Each callout parameter consists of a parameter name and a parameter value. additionalProperties: type: string description: | The callout parameter consists of a key-value pair: * Field key: the name of the callout parameter. * Field value: the value of the callout parameter. You can add merge fields in the field name or value. For example, `"AccountNumber": "{{DataSource.Account.AccountNumber}}"`. For more information, see Merge field syntax for email and callout templates. Alternatively, you can use the `customRequestBody` field for JSON-formatted callout parameters sent in the callout body. calloutRetry: default: true description: Specified whether to retry the callout when the callout fails. The default value is `true`. type: boolean certificate: type: string description: | The SSL certificate for the domain of the callout receiver server specified in `calloutBaseurl`. The value must be in PEM format, which typically starts with `-----BEGIN CERTIFICATE-----` and ends with `-----END CERTIFICATE-----`. Specifying the SSL certificate can eliminate SSL certificate errors (HTTP status code 495) for callout notifications. customRequestBody: type: string description: | Customized request body. This field is available only for callouts whose Content-Type in the request body is `application/json`. The value must be in JSON format and double quotes in the value must be escaped. You can add merge fields to the request body. For example, `{\"AccountNumber\": \"{{DataSource.Account.AccountNumber}}\",\"AccountId\": \"{{DataSource.Account.Id}}\"}`. For more information, see Merge field syntax for email and callout templates. You must set `useCustomRequestBody` to `true` if you want to customize the callout request body with this field. Alternatively, you can use the `calloutParams` field. description: description: Description for the callout template. maxLength: 255 type: string hmacAlgorithm: type: string description: | The hash function Zuora uses to generate the signed data for HMAC authentication. enum: - MD5 - SHA-1 - SHA-224 - SHA-256 - SHA-384 - SHA-512 hmacData: type: string description: | The message to be authenticated for HMAC authentication. You can use merge fields in this value: - `{{Request.Headers.}}`: Refers to the value of a particular request header. For example, `{{Request.Headers.Date}}` refers to the value of the request header called `Date`. - `{{Request.Body}}`: Refers to the request body. - Other merge fields: See Merge field syntax for email and callout templates. hmacKey: type: string description: | The header key that Zuora uses to send the header value for HMAC authentication. The header value is specified in the `hmacValue` field and typically contains the signed data. hmacOutputFormat: type: string description: | The format of the signed data for HMAC authentication. enum: - BASE64 - HEX hmacSecret: type: string description: | The shared secret key that Zuora uses to generate the signed data for HMAC authentication. hmacValue: type: string description: | The header value for HMAC authentication. The header key is specified in the `hmacKey` field. You can use merge fields in this value: - `{{Request.HMAC.Signed}}`: Refers to the signed data. - Other merge fields: See Merge field syntax for email and callout templates. The following is a header value example: `The algorithm is SHA-256 and the signed data is {{Request.HMAC.Signed}}`. httpMethod: description: The HTTP method of the callout. enum: - POST - GET - PUT - PATCH - DELETE example: POST type: string name: description: The name of the callout template. It must be unique across all callout templates. maxLength: 255 type: string useCustomRequestBody: type: boolean description: | Indicates whether to enable the customized request body configured in the `customRequestBody` field. type: object PUTPublicCalloutTemplateRequestBasicAuthentication: title: Callout - Base authentication allOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - type: object description: | The Basic Authentication information for callout templates. properties: requiredAuth: description: | Indicates whether Basic authentication is enabled for the callout. type: boolean calloutAuth: $ref: '#/components/schemas/CalloutAuth' PUTPublicCalloutTemplateRequestOauth2Authentication: title: Callout - OAuth 2.0 authentication allOf: - $ref: '#/components/schemas/PUTPublicCalloutTemplateRequestCommon' - type: object description: | The OAuth 2.0 Authentication information for callout templates. properties: requiredOauth2: description: | Indicates whether OAuth 2.0 authentication is enabled for the callout. type: boolean oauth2ProviderId: description: | The ID of the OAuth 2.0 provider in your tenant that provides access tokens for the callout. For more information about how to get the ID of an OAuth 2.0 provider, see Retrieve the ID of an OAuth 2.0 provider. CreateOrUpdateReusableBlockRequest: properties: allowPartialSuccess: description: | When set to false, the call will fail if one or multiple instances fail to import, and a 200 response is returned if all reusable blocks have been successfully updated. When set to true, a success (200) response is returned if one or more instances have imported successfully. All failed instances are also returned in the response. type: boolean reusableBlocks: description: | A container for reusable blocks. maxItems: 1000 minItems: 1 items: $ref: '#/components/schemas/CreateOrUpdateReusableBlockFormat' type: array type: object CreateOrUpdateReusableBlockResponse: example: reasons: [] properties: reasons: description: | Returns an empty array if the request succeeds. items: type: string type: array type: object CreateOrUpdateReusableBlockFormat: properties: active: default: true description: | The status of the reusable block. Only active blocks can be embedded into email templates. type: boolean category: description: | The category of the reusable block. You can filter blocks by category when editing email templates in the UI. type: string enum: - Headers - Footers - Other content: description: | The content of the reusable block, which is automatically inserted into email templates when sending email notifications. type: string id: description: | ID of an existing reusable block. Specify this field if you want to update an existing reusable block. You must provide all fields when updating an existing reusable block. type: string name: description: | The name of the reusable block. The value must be unique across all blocks. type: string number: description: | The number of the reusable block. The value must be unique across all blocks. If not specified, a unique value will be provided by default. type: string tags: description: | List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter. items: type: string type: array required: - category - content - name type: object CreatePublicReusableBlockRequest: example: name: Header Block category: Headers content: (The content of the block) properties: active: default: true description: | The status of the reusable block. Only active blocks can be embedded into email templates. type: boolean category: description: | The category of the reusable block. You can filter blocks by category when editing email templates in the UI. type: string enum: - Headers - Footers - Other content: description: | The content of the reusable block, which is automatically inserted into email templates when sending email notifications. type: string name: description: | The name of the reusable block. The value must be unique across all blocks. type: string number: description: | The number of the reusable block. The value must be unique across all blocks. If not specified, a unique value will be provided by default. type: string tags: description: | List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter. items: type: string type: array required: - category - content - name type: object GetPublicReusableBlockResponse: example: id: c6af751e4a0041eebb000c51e95e6c2d createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2025-04-22T08:17:24.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2025-04-22T08:17:24.000 UTC active: true name: Header Block number: RB-00000010 category: Headers tags: [] content: (The content of the block) properties: active: default: true description: | The status of the reusable block. Only active blocks can be embedded into email templates. type: boolean category: description: | The category of the reusable block. You can filter blocks by category when editing email templates in the UI. type: string enum: - Headers - Footers - Other content: description: | The content of the reusable block, which is automatically inserted into email templates when sending email notifications. type: string createdBy: description: | The ID of the user who created the reusable block. format: uuid type: string createdOn: description: | The time when the reusable block was created. format: date-time type: string id: description: | The ID of the reusable block. format: uuid type: string name: description: | The name of the reusable block. The value must be unique across all blocks. type: string number: description: | The number of the reusable block. The value must be unique across all blocks. If not specified, a unique value will be provided by default. type: string tags: description: | List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter. items: type: string type: array updatedBy: description: | The ID of the user who updated the reusable block. format: uuid type: string updatedOn: description: | TThe time when the reusable block was updated. format: date-time type: string type: object UpdatePublicReusableBlockRequest: example: tag: - logo properties: active: default: true description: | The status of the reusable block. Only active blocks can be embedded into email templates. type: boolean category: description: | The category of the reusable block. You can filter blocks by category when editing email templates in the UI. type: string enum: - Headers - Footers - Other content: description: | The content of the reusable block, which is automatically inserted into email templates when sending email notifications. type: string name: description: | The name of the reusable block. The value must be unique across all blocks. type: string number: description: | The number of the reusable block. The value must be unique across all blocks. type: string tags: description: | List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter. items: type: string type: array type: object UpdatePublicReusableBlockResponse: example: id: c6af751e4a0041eebb000c51e95e6c2d createdBy: 8a90e08282f4ed040182f67bab2902ff createdOn: 2025-04-22T08:17:24.000 UTC updatedBy: 8a90e08282f4ed040182f67bab2902ff updatedOn: 2025-04-22T08:17:24.000 UTC active: true name: Header Block number: RB-00000010 category: Headers tags: - logo content: (The content of the block) properties: active: default: true description: | The status of the reusable block. Only active blocks can be embedded into email templates. type: boolean category: description: | The category of the reusable block. You can filter blocks by category when editing email templates in the UI. type: string enum: - Headers - Footers - Other content: description: | The content of the reusable block, which is automatically inserted into email templates when sending email notifications. type: string createdBy: description: | The ID of the user who created the reusable block. format: uuid type: string createdOn: description: | The time when the reusable block was created. format: date-time type: string id: description: | The ID of the reusable block. format: uuid type: string name: description: | The name of the reusable block. The value must be unique across all blocks. type: string number: description: | The number of the reusable block. The value must be unique across all blocks. If not specified, a unique value will be provided by default. type: string tags: description: | List of tags that help you quickly locate reusable blocks when editing email templates in the UI by using the tag filter. items: type: string type: array updatedBy: description: | The ID of the user who updated the reusable block. format: uuid type: string updatedOn: description: | TThe time when the reusable block was updated. format: date-time type: string type: object NotificationsHistoryDeletionTaskResponse: description: The notification history deletion task information. properties: accountId: description: The ID of the account whose notification histories are deleted by the current deletion task. format: uuid type: string createdBy: description: The ID of the user who submits the notification history deletion task. format: uuid type: string createdOn: description: The timestamp when the notification history deletion task is created. type: integer id: description: The ID of the notification history deletion task. format: uuid type: string status: description: The status of the notification history deletion task. enum: - RUNNING - FINISHED - FAILED type: string tenantId: description: The ID of the tenant where the notification history deletion task runs. type: string type: object POSTResendCalloutNotifications: example: - a02ea6d76931475bb73fcd339b5f6ht8g - 40dbbc5f2cfb4e2fa236db11ea1dfghht - a3fd8e81c20a4ac0a1eb3747339asdfef - a00000000000000000000000000000000 items: description: | ID for failed callout notifications. You can resend at most 1000 callout notifications at a time. type: string type: array ResendCalloutNotificationsFailedResponse: additionalProperties: description: | The ID of a fail-to-resend callout notification history object, containing an object with the error code and message. **Note:** Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend callout notification history. properties: code: description: | The error code of response. type: string message: description: The detail information of the error response type: string type: object type: object POSTResendEmailNotifications: example: - a02ea6d76931475bb73fcd339b5f6ht8g - 40dbbc5f2cfb4e2fa236db11ea1dfghht - a3fd8e81c20a4ac0a1eb3747339asdfef - a00000000000000000000000000000000 items: description: | ID for failed email notifications. You can resend at most 1000 email notifications at a time. type: string type: array ResendEmailNotificationsFailedResponse: additionalProperties: description: | The ID of a fail-to-resend email notification history object, containing an object with the error code and message. **Note:** Multiple records of this field are allowed in the response. Each of them represents a fail-to-resend email notification history. properties: code: description: | The error code of response. type: string message: description: The detail information of the error response type: string type: object type: object GETCalloutHistoryVOsType: properties: calloutHistories: description: | A container for callout histories. items: $ref: '#/components/schemas/GETCalloutHistoryVOType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETCalloutHistoryVOType: properties: attemptedNum: description: | The number of times the callout was retried. type: string createTime: description: | The time that the calloutHistory record was made. type: string eventCategory: description: | The event category for the callout. type: string eventContext: description: | The context of the callout event. type: string notification: description: | The name of the notification. type: string requestMethod: description: | The request method set in notifications settings. type: string requestUrl: description: | The base url set in notifications settings. type: string responseCode: description: | The responseCode of the request. type: string responseContent: description: '' type: string title: calloutHistories type: object GETEmailHistoryVOsType: properties: emailHistories: description: | A container for email histories. items: $ref: '#/components/schemas/GETEmailHistoryVOType' type: array nextPage: description: | URL to retrieve the next page of the response if it exists; otherwise absent. format: URL type: string success: description: | Returns `true` if the request was processed successfully. type: boolean type: object GETEmailHistoryVOType: properties: accountId: description: | ID of an account. type: string bcc: description: | Blind carbon copy recipients of the email. type: string cc: description: | Carbon Copy recipients of the email. type: string errorMessage: description: | null if the content of result is "OK". A description of the error if the content of result is not "OK". type: string eventCategory: description: | The event category of the email. type: string fromEmail: description: | The sender of the email. type: string notification: description: | The name of the notification. type: string replyTo: description: | The reply-to address as configured in the email template. type: string result: description: | The result from the mail server of sending the email. type: string sendTime: description: | The date and time the email was sent. type: string subject: description: | The subject of the email. type: string toEmail: description: | The intended recipient of the email. type: string title: emailHistories type: object PostCustomObjectDefinitionsRequest: example: definitions: Vehicle: label: Vehicle object: Vehicle properties: DeviceId__c: label: Device ID type: string maxLength: 20 OrderId__c: label: Order ID type: string format: uuid relationships: - namespace: com_zuora object: orders fields: OrderId__c: Id properties: definitions: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinitions' type: object GETAllCustomObjectDefinitionsInNamespaceResponse: example: Id: f67635c8-094e-4ffc-90be-5dba5c639494 type: Vehicle CreatedById: 8ad084a67f9c7138017fab8a8b511b5a UpdatedById: 8ad084a67f9c7138017fab8a8b511b5a CreatedDate: '2024-11-15T06:13:27.338Z' UpdatedDate: '2024-11-15T06:13:27.338Z' schema: object: Vehicle label: Vehicle enableCreateRecordAuditing: false enableDeleteRecordAuditing: false properties: DeviceId__c: maxLength: 20 label: Device ID origin: custom type: string OrderId__c: format: uuid label: Order ID origin: custom type: string Id: format: uuid label: Id origin: system type: string CreatedById: label: CreatedById origin: system type: string UpdatedById: label: UpdatedById origin: system type: string CreatedDate: format: date-time label: CreatedDate origin: system type: string UpdatedDate: format: date-time label: UpdatedDate origin: system type: string required: - Id - CreatedById - UpdatedById - CreatedDate - UpdatedDate filterable: - OrderId__c - Id - CreatedDate - UpdatedDate relationships: - cardinality: manyToOne namespace: com_zuora object: orders fields: OrderId__c: Id recordConstraints: create: enforceValidMapping: true - cardinality: manyToOne namespace: com_zuora object: User fields: CreatedById: Id recordConstraints: create: enforceValidMapping: true - cardinality: manyToOne namespace: com_zuora object: User fields: UpdatedById: Id recordConstraints: create: enforceValidMapping: true enableRecordMigration: false properties: count: description: The number of objects in the `definitions` object. The value of this field is the number of custom object definitions in the namespace. type: integer definitions: $ref: '#/components/schemas/CustomObjectDefinitions' type: object CustomObjectDefinitions: additionalProperties: $ref: '#/components/schemas/CustomObjectDefinition' description: The custom object definitions. This object maps types to custom object definitions. title: customObjectDefinitions type: object CustomObjectDefinition: example: CreatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c CreatedDate: '2019-09-29T06:45:23.378Z' Id: df7f10f9-4ec9-4389-a9eb-a6a3d549bb61 UpdatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c UpdatedDate: '2019-09-29T06:45:23.378Z' schema: filterable: - last_name__c - email__c label: Personal Profile object: person properties: CreatedById: format: uuid label: CreatedById origin: system type: string CreatedDate: format: date-time label: CreatedDate origin: system type: string Id: format: uuid label: Id origin: system type: string UpdatedById: format: uuid label: UpdatedById origin: system type: string UpdatedDate: format: date-time label: UpdatedDate origin: system type: string age__c: description: Age in years minimum: 0 origin: custom type: integer email__c: format: email maxLength: 128 origin: custom type: string home_address__c: format: uuid origin: custom type: string last_name__c: maxLength: 128 origin: custom type: string marital_status__c: default: Unknown enum: - Single - Married - Unknown origin: custom type: string work_address__c: format: uuid origin: custom type: string relationships: - cardinality: manyToOne fields: home_address__c: Id namespace: default object: address recordConstraints: create: enforceValidMapping: false - cardinality: manyToOne fields: work_address__c: Id namespace: default object: address recordConstraints: create: enforceValidMapping: false - cardinality: oneToMany fields: Id: person_id__c namespace: default object: car recordConstraints: create: enforceValidMapping: false - cardinality: oneToMany fields: Id: person_id__c namespace: default object: device recordConstraints: create: enforceValidMapping: false required: - last_name__c - marital_status__c type: object type: person properties: CreatedById: description: The creator's Id format: uuid type: string CreatedDate: description: The creation time of the custom object definition in date-time format. format: date-time type: string Id: description: The unique Id of the custom object definition format: uuid type: string UpdatedById: description: The modifier's Id format: uuid type: string UpdatedDate: description: The update time of the custom object definition in date-time format. format: date-time type: string schema: description: The schema of the custom object definition properties: auditable: description: The set of fields which Audit Trail tracks and records changes of. items: type: string type: array enableCreateRecordAuditing: description: Indicates whether to audit the creation of custom object records of this custom object definition. type: boolean enableDeleteRecordAuditing: description: Indicates whether to audit the deletion of custom object records of this custom object definition. type: boolean filterable: description: The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable. items: type: string type: array label: description: A label for the custom object type: string object: description: The API name of the custom object type: string properties: $ref: '#/components/schemas/CustomObjectAllFieldsDefinition' relationships: description: An array of relationships with Zuora objects or other custom objects items: additionalProperties: false properties: cardinality: default: manyToOne description: | The cardinality of the relationship from this object to another object. A `manyToOne` relationship means this object is the child object (the "many" side), and the referenced object (the "one" side) is the parent. A `oneToMany` relationship means this object is the parent object (the "one" side), and the referenced object (the "many" side) is the child. enum: - manyToOne - oneToMany type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: description: The namespace where the related object is located type: string object: description: The API name of the related object type: string recordConstraints: description: | Specifies contraints to apply to custom object records. properties: create: properties: enforceValidMapping: description: | Specifies whether Zuora validates the values of mapped fields in custom object records. type: boolean type: object type: object type: object type: array required: description: The required fields of the custom object definition. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records. items: type: string type: array type: description: The custom object definition type. Can only be `object` currently. enum: - object type: string unique: description: The fields with unique constraints. items: type: string type: array type: object type: description: The API name of the custom object type: string title: customObjectDefinition type: object CustomObjectAllFieldsDefinition: allOf: - properties: CreatedById: description: The `CreatedById` field definition properties: format: description: The field data format enum: - uuid type: string label: description: The UI name of the field type: string origin: description: Specifies whether the field is a system field or a custom field enum: - system type: string type: description: The field data type enum: - string type: string type: object CreatedDate: description: The `CreatedDate` field definition properties: format: description: The field data format enum: - date-time type: string origin: description: Specifies the field is a system field enum: - system type: string type: description: The field data type enum: - string type: string type: object Id: description: The `Id` field definition properties: format: description: The field data format enum: - uuid type: string label: description: The UI name of the field type: string origin: description: Specifies whether the field is a system field or a custom field enum: - system type: string type: description: The field data type enum: - string type: string type: object UpdatedById: description: The `UpdatedById` field definition properties: format: description: The field data format enum: - uuid type: string label: description: The UI name of the field type: string origin: description: Specifies whether the field is a system field or a custom field enum: - system type: string type: description: The field data type enum: - string type: string type: object UpdatedDate: description: The `UpdatedDate` field definition properties: format: description: The field data format enum: - date-time type: string origin: description: Specifies the field is a system field enum: - system type: string type: description: The field data type enum: - string type: string type: object type: object - $ref: '#/components/schemas/CustomObjectCustomFieldsDefinition' description: The definitions of all the fields in the custom object definition title: customObjectFieldDefinition FieldsAdditionalProperties: additionalProperties: type: string description: | Field mappings in the form of ``: ``. title: relationshipFieldMapping type: object CustomObjectCustomFieldsDefinition: additionalProperties: $ref: '#/components/schemas/CustomObjectCustomFieldDefinition' description: The custom field definition in the custom object definition title: customObjectCustomFieldDefinition type: object CustomObjectCustomFieldDefinition: description: The custom field definition in the custom object properties: displayName: description: | Indicates whether to use this field as the display name of the custom object when being linked to another custom object. This field applies only to the Text custom field type: - The `type` field is `string`. - The `enum` field is not specified. type: boolean format: description: The data format of the custom field type: string label: description: The UI label of the custom field type: string maxLength: description: | The maximum length of string that can be stored in the custom field. This field applies only to the following custom field types: - Text: - The `type` field is `string`. - The `format` field is not specified or is `url`. - The `enum` field is not specified. - Long Text: - The `type` field is `string`. - The `format` field is `long-text`. - Picklist: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is not specified or is `false`. - Multiselect: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is `true`. type: integer multiselect: description: | Indicates whether this is a multiselect custom field. This field applies only to the Picklist or Multiselect custom field types: - The `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified. type: boolean origin: description: Specifies that this is a custom field enum: - custom type: string type: description: The data type of the custom field type: string title: customObjectCustomFieldDefinition type: object PostCustomObjectDefinitionsRequestDefinitions: additionalProperties: $ref: '#/components/schemas/PostCustomObjectDefinitionsRequestDefinition' description: | The custom object definitions. This object maps types to custom object definitions. title: customObjectDefinitions type: object PostCustomObjectDefinitionsRequestDefinition: properties: auditable: description: The set of fields which Audit Trail tracks and records changes of. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields. items: type: string type: array enableCreateRecordAuditing: default: false description: | Indicates whether to audit the creation of custom object records of this custom object definition. Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see Manage audit trail settings. type: boolean enableDeleteRecordAuditing: default: false description: | Indicates whether to audit the deletion of custom object records of this custom object definition. Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see Manage audit trail settings. type: boolean filterable: description: The set of fields that are allowed to be queried on. Queries on non-filterable fields will be rejected. You can not change a non-filterable field to filterable. items: type: string type: array label: description: A UI label for the custom object type: string object: description: The API name of the custom object type: string properties: $ref: '#/components/schemas/PostCustomObjectDefinitionFieldsDefinitionRequest' relationships: description: An array of relationships with Zuora objects or other custom objects. You can add at most 2 `manyToOne` relationships when creating a custom field definition. items: additionalProperties: false properties: cardinality: description: | The cardinality of the relationship from this object to another object. Only the `manyToOne` cardinality can be used when creating relationships. A relationship with `oneToMany` cardinality is created implicitly when a `manyToOne` relationship is created. A custom object definition can have a maximum of 2 `manyToOne` relationships. enum: - manyToOne type: string fields: $ref: '#/components/schemas/FieldsAdditionalPropertiesForPostDefinition' namespace: description: The namespace where the related object is located type: string object: description: The API name of the related object type: string recordConstraints: description: | Specifies contraints to apply to custom object records. properties: create: properties: enforceValidMapping: default: true description: | Specifies whether Zuora validates the values of mapped fields in custom object records. By default, Zuora validates the values of mapped fields in custom object records. For example, if the custom object definition has a field called `AccountId__c` that is mapped to the `Id` field of the `account` object, Zuora verifies that the value of `AccountId__c` is a valid account ID when a custom object record is created. If the value of `AccountId__c` is not a valid account ID, the operation fails. type: boolean type: object type: object required: - namespace - object - fields type: object type: array required: description: The required fields of the custom object. You can change required fields to optional. However, you can only change optional fields to required on the custom objects with no records. items: type: string type: array unique: description: The fields with unique constraints. You can remove the unique constraint on a field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints. items: type: string type: array required: - object - label title: customObjectDefinition type: object PostCustomObjectDefinitionFieldsDefinitionRequest: additionalProperties: $ref: '#/components/schemas/PostCustomObjectDefinitionFieldDefinitionRequest' title: customObjectCustomFieldDefinitions type: object FieldsAdditionalPropertiesForPostDefinition: additionalProperties: type: string description: | Field mappings in the form of ``: ``. Usually the `` can only be the `Id` field of the related object. Two exceptions are Subscription Name and Rate Plan Charge Number as both of them are unique. title: relationshipFieldMapping type: object PostCustomObjectDefinitionFieldDefinitionRequest: properties: displayName: description: | Indicates whether to use this field as the display name of the custom object when being linked to another custom object. This field applies only to the Text custom field type: - The `type` field is `string`. - The `enum` field is not specified. type: boolean format: description: The data format of the custom field type: string label: description: The UI label of the custom field type: string maxLength: description: | The maximum length of string that can be stored in the custom field. This field applies only to the following custom field types: - Text: - The `type` field is `string`. - The `format` field is not specified or is `url`. - The `enum` field is not specified. - Long Text: - The `type` field is `string`. - The `format` field is `long-text`. - Picklist: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is not specified or is `false`. - Multiselect: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is `true`. type: integer multiselect: description: | Indicates whether this is a multiselect custom field. This field applies only to the Picklist or Multiselect custom field types: - The `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified. type: boolean type: description: The data type of the custom field type: string required: - type - label title: customObjectCustomFieldDefinition type: object MigrationUpdateCustomObjectDefinitionsRequest: additionalProperties: false properties: actions: description: The actions of updating custom object definitions, to be performed as parts of the migration. Currently only one action per migration is supported. items: $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionRequest' maxItems: 1 minItems: 1 type: array required: - actions type: object MigrationUpdateCustomObjectDefinitionsResponse: additionalProperties: false properties: actions: description: The actions of updating custom object definitions, to be performed as parts of the migration. Currently only one action per migration is supported. items: $ref: '#/components/schemas/CustomObjectDefinitionUpdateActionResponse' maxItems: 1 minItems: 1 type: array type: object CustomObjectDefinitionUpdateActionResponse: example: field: definition: description: Address zip code label: Zip code maxLength: 10 type: string name: zip__c namespace: default object: address type: addField properties: description: description: Optional property for `updateObject` action type: string enableCreateRecordAuditing: description: Indicates whether to audit the creation of custom object records of this custom object definition. type: boolean enableDeleteRecordAuditing: description: Indicates whether to audit the deletion of custom object records of this custom object definition. type: boolean field: $ref: '#/components/schemas/UpdateCustomObjectCusotmField' label: description: Optional property for `updateObject` action type: string namespace: description: The namespace of the custom object definition to be updated type: string object: description: The API name of the custom object definition to be updated type: string relationship: additionalProperties: false properties: cardinality: default: manyToOne description: | The cardinality of the relationship from this object to another object. A `manyToOne` relationship means this object is the child object (the "many" side), and the referenced object (the "one" side) is the parent. A `oneToMany` relationship means this object is the parent object (the "one" side), and the referenced object (the "many" side) is the child. enum: - manyToOne - oneToMany type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: description: The namespace where the related object is located type: string object: description: The API name of the related object type: string recordConstraints: description: | Specifies contraints to apply to custom object records. properties: create: properties: enforceValidMapping: default: true description: | Specifies whether Zuora validates the values of mapped fields in custom object records. type: boolean type: object type: object type: object type: description: The type of the updating action on a custom object definition enum: - addField - deleteField - updateField - updateObject - renameField - addRelationship - deleteRelationship type: string type: object UpdateCustomObjectCusotmField: description: A reference to a field. properties: auditable: description: | Indicates whether Audit Trail will record changes of this custom field. You can change auditable fields to non-auditable, and vice versa. One custom object can have a maximum of five auditable fields. type: boolean definition: $ref: '#/components/schemas/CustomObjectCustomFieldDefinitionUpdate' filterable: description: | Indicates whether the field is filterable or not. Applicable to `addField` and `updateField` actions. You can change a filterable field to non-filterable and vice versa. You can also add a filterable field. One custom object can have a maximum of 10 filterable fields. Note that changing filterable fields triggers reindexing. It will take 12-24 hours before all your data are reindexed and available to query. type: boolean name: description: The name of the custom field to be updated type: string required: description: | Indicates whether the field is required or optional. You can update a required field to optional. On the other hand, you can only update an optional field to required on the custom object with no records. You can only add a required field to the custom object with no records. type: boolean targetName: description: Required if the `type` of the action is `renameField` type: string unique: description: | Indicates whether to specify a unique constraint to the field. You can remove the unique constraint on the field. However, you can only add a unique constraint to a filterable field if the custom object contains no record. One custom object can have a maximum of five fields with unique constraints. type: boolean type: object CustomObjectCustomFieldDefinitionUpdate: description: The custom field definition in the custom object properties: default: description: Applicable if the `type` of the action is `updateField` type: string description: description: Applicable if the `type` of the action is `updateField` type: string displayName: description: | Indicates whether to use this field as the display name of the custom object when being linked to another custom object. This field applies only to the Text custom field type: - The `type` field is `string`. - The `enum` field is not specified. type: boolean format: description: The data format of the custom field type: string label: description: The UI label of the custom field type: string maxLength: description: | The maximum length of string that can be stored in the custom field. This field applies only to the following custom field types: - Text: - The `type` field is `string`. - The `format` field is not specified or is `url`. - The `enum` field is not specified. - Long Text: - The `type` field is `string`. - The `format` field is `long-text`. - Picklist: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is not specified or is `false`. - Multiselect: - The `type` field is `string`. - The `enum` field is specified. - The `multiselect` field is `true`. type: integer multiselect: description: | Indicates whether this is a multiselect custom field. This field applies only to the creation of Picklist or Multiselect custom fields: - The action `type` field is `addField`. - The definition `type` field is `string`. - The `maxLength` field is specified. - The `enum` field is specified. type: boolean origin: description: Specifies that this is a custom field enum: - custom type: string type: description: The data type of the custom field type: string title: customObjectCustomFieldDefinition type: object CustomObjectDefinitionUpdateActionRequest: example: field: definition: description: Address zip code label: Zip code maxLength: 10 type: string name: zip__c namespace: default object: address type: addField properties: description: description: Optional property for `updateObject` action type: string enableCreateRecordAuditing: description: | Optional property for `updateObject` action. Indicates whether to audit the creation of custom object records of this custom object definition. Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record creation. For more information, see Manage audit trail settings. type: boolean enableDeleteRecordAuditing: description: | Optional property for `updateObject` action. Indicates whether to audit the deletion of custom object records of this custom object definition. Note that you must enable the **Custom Object Definition** audit trail setting in your Zuora tenant before auditing custom object record deletion. For more information, see Manage audit trail settings. type: boolean field: $ref: '#/components/schemas/UpdateCustomObjectCusotmField' label: description: Optional property for `updateObject` action type: string namespace: description: The namespace of the custom object definition to be updated type: string object: description: The API name of the custom object definition to be updated type: string relationship: additionalProperties: false properties: cardinality: description: | The cardinality of the relationship from this object to another object. Only the `manyToOne` cardinality can be used when creating relationships. A relationship with `oneToMany` cardinality is created implicitly when a `manyToOne` relationship is created. A custom object definition can have a maximum of 2 `manyToOne` relationships. enum: - manyToOne type: string fields: $ref: '#/components/schemas/FieldsAdditionalProperties' namespace: description: The namespace where the related object is located type: string object: description: The API name of the related object type: string recordConstraints: description: | Specifies contraints to apply to custom object records. properties: create: properties: enforceValidMapping: default: true description: | Specifies whether Zuora validates the values of mapped fields in custom object records. By default, Zuora validates the values of mapped fields in custom object records. For example, if the custom object definition has a field called `AccountId__c` that is mapped to the `Id` field of the `account` object, Zuora verifies that the value of `AccountId__c` is a valid account ID when a custom object record is created. If the value of `AccountId__c` is not a valid account ID, the operation fails. type: boolean type: object type: object required: - namespace - object - fields type: object type: description: The type of the updating action on a custom object definition enum: - addField - deleteField - updateField - updateObject - renameField - addRelationship - deleteRelationship type: string required: - type - namespace - object type: object PostCustomObjectRecordsRequest: properties: allowPartialSuccess: default: false description: Indicates whether the records that pass the schema validation should be created when not all records in the request pass the schema validation. example: true type: boolean records: description: A list of custom object records to be created items: $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' type: array required: - records type: object PostCustomObjectRecordsResponse: properties: error: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' records: description: The custom object records that are succesfully created and stored items: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: array type: object CustomObjectRecordsErrorResponse: properties: code: example: 710125XX format: Int32 type: integer details: example: - code: 710125XX message: Field [age__c] is an integer field but received a string value. record: Id: 8a19f16a-2b5e-4a26-bb20-c79cd6984714 age__c: '32' email__c: smith123@example.com home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee last_name__c: Smith marital_status__c: Married work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714 items: $ref: '#/components/schemas/CustomObjectRecordsWithError' type: array message: example: Unabled to create object records due to invalid request. type: string type: object ErrorResponse401Record: properties: code: example: 7101251X format: Int32 type: integer details: example: - code: 7101251X message: Unauthorized to view object record. items: $ref: '#/components/schemas/Error401' type: array message: example: Unauthorized to process object record. type: string type: object CustomObjectRecordsThrottledResponse: properties: code: example: 71012561 format: Int32 type: integer details: example: - code: 71012561 message: Unable to process record due to internal error or database throttling. record: Id: 8a19f16a-2b5e-4a26-bb20-c79cd6984714 age__c: 32 email__c: smith123@example.com home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee last_name__c: Smith marital_status__c: Married work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714 items: $ref: '#/components/schemas/CustomObjectRecordsWithError' type: array message: example: Unabled to create object records, please try again later. type: string type: object CustomObjectRecordsWithError: properties: code: description: | 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. enum: - 71012520 - 71012521 - 71012522 - 71012523 - 71012524 - 71012525 - 71012526 - 71012530 format: Int32 type: integer message: example: Field [last_name__c] cannot accept empty string. type: string record: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: object CustomObjectRecordWithAllFields: allOf: - properties: CreatedById: description: The creator's Id type: string CreatedDate: description: The record creation time in the date-time format format: date-time type: string Id: description: The unique Id of the custom object record format: uuid maxLength: 36 minLength: 36 type: string UpdatedById: description: The modifier's Id type: string UpdatedDate: description: The record modification time in the date-time format format: date-time type: string type: description: The type of the custom object record. It is the API name of the custom object definition. type: string - $ref: '#/components/schemas/CustomObjectRecordWithOnlyCustomFields' description: Record data from an object example: Id: e0668230-eb63-40df-be65-08f083ca47b1 type: Vehicle CreatedById: 8ad09fc28193c189018194da28be74ba UpdatedById: b243314d594646d3b2651aeedd4be47e CreatedDate: '2024-07-17T03:23:47.698Z' UpdatedDate: '2024-07-17T03:26:28.772Z' DeviceId__c: '10101011' OrderId__c: c086028c-5df8-427d-a3c8-7a7fb5d32d3d title: customObjectRecord type: object CustomObjectRecordWithOnlyCustomFields: additionalProperties: description: The field-value pairs for a custom object record example: DeviceId__c: '10101011' title: customObjectRecord type: object Error401: properties: code: example: 7101251X format: Int32 type: integer message: example: Unauthorized Action type: string type: object QueryCustomObjectRecordsResponse: properties: count: description: The record count of the given custom object type example: 1 type: integer records: example: - CreatedById: 58bcc694-0b01-4c38-83d9-679891aee4dc CreatedDate: '2017-06-07T17:26:47.501Z' Id: f4f3d0a8-9d45-43d6-956c-4820f2de7559 UpdatedById: 58bcc694-0b01-4c38-83d9-679891aee4dc UpdatedDate: '2017-06-07T17:26:47.501Z' age__c: 32 email__c: smith123@example.com home_address__c: 59b38ad1-27d4-40e8-af66-8c138bc382ee last_name__c: Smith marital_status__c: Married type: person version: 1 work_address__c: 8a19f16a-2b5e-4a26-bb20-c79cd6984714 items: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' type: array required: - count - records type: object CustomObjectRecordBatchRequest: description: Request of processing custom object records in batch. example: action: type: update records: 64edb2a5-2796-4e95-9559-846f8636a01b: DeviceId__c: '10101011' properties: action: $ref: '#/components/schemas/CustomObjectRecordBatchAction' required: - action type: object CustomObjectRecordsBatchUpdatePartialSuccessResponse: example: {} properties: error: $ref: '#/components/schemas/CustomObjectRecordsErrorResponse' type: object CustomObjectRecordBatchAction: description: The batch action on custom object records properties: allowPartialSuccess: default: false description: | Indicates whether the records that pass the schema validation should be updated when not all records in the request pass the schema validation. Only applicable when `type` is `update`. example: true type: boolean ids: description: Ids of the custom object records that you want to delete. Each ID must be a string of 36 characters. Only applicable when `type` is `delete`. example: - 64edb2a5-2796-4e95-9559-846f8636a01b - dbfb35a3-dd2b-42c9-b8f7-eb36fed1a1e1 - 2c2a1810-bfef-4150-84de-50e769978e42 items: format: uuid type: string type: array records: $ref: '#/components/schemas/CustomObjectRecordBatchUpdateMapping' type: description: The type of the batch action enum: - delete - update type: string required: - type title: updateDeleteBatchAction type: object CustomObjectRecordBatchUpdateMapping: additionalProperties: description: Map of object Id and associated custom fields data to be updated type: object description: Object records that you want to update. Only applicable when `type` is `update`. example: 64edb2a5-2796-4e95-9559-846f8636a01b: name__c: elba43 person_id__c": 30c52793-8f06-41c6-b623-04829710d7a title: updateIdFieldsMapping type: object CustomObjectBulkJobRequest: example: object: passenger namespace: default operation: delete filter: conditions: - field: CreatedDate operator: LT value: '2020-01-01T00:00:00.000Z' properties: filter: $ref: '#/components/schemas/CustomObjectBulkDeleteFilter' namespace: description: | The namespace of the object. Custom objects belong to the `default` namespace. Zuora standard objects belong to the `com_zuora` namespace. Bulk job operations on the following Zuora standard objects are supported: * SavedQuery enum: - default - com_zuora type: string object: description: The object that the bulk operation performs on. example: passenger type: string operation: description: The operation that the bulk job performs. Only the users that have the "Delete Custom Objects" permission can submit a `delete` bulk job request. Only the users that have the "Edit Custom Objects" permission can submit a `create` or `update` bulk job request. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information. enum: - delete - create - update type: string required: - operation - object - namespace type: object CustomObjectBulkJobResponse: example: CreatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c CreatedDate: '2021-03-15T06:47:18Z' Id: ed4b9701-bafb-4976-8019-b08269430153 UpdatedById: 7b39d73f-22e6-404a-b8e7-894f7620e91c UpdatedDate: '2021-03-15T06:47:18Z' error: code: 71012560 message: Service limit reached, please retry later. namespace: default object: passenger operation: delete processingTime: 1882 recordsProcessed: 500 status: failed properties: CreatedById: description: The ID of the user who creates the job. format: uuid type: string CreatedDate: description: The time when the bulk job is created. format: date-time type: string Id: description: The custom object bulk job ID. format: uuid type: string UpdatedById: description: The ID of the user who updates the job. format: uuid type: string UpdatedDate: description: The time when the bulk job is updated. format: date-time type: string error: properties: code: description: The error code. example: 71012560 format: Int32 type: integer message: description: The error message. example: Service limit reached, please retry later. type: string type: object namespace: description: | The namespace of the object. Custom objects belong to the `default` namespace. Zuora standard objects belong to the `com_zuora` namespace. Bulk job operations on the following Zuora standard objects are supported: * SavedQuery enum: - default - com_zuora type: string object: description: The object to that the bulk operation performs on. example: passenger type: string operation: description: | The operation that the bulk job performs. Only the users that have the "Delete Custom Objects" permission can submit a `delete` bulk job request. Only the users that have the "Edit Custom Objects" permission can submit a `create` or `update` bulk job request. See [Platform Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/h_Platform_Roles#Platform_Permissions) for more information. enum: - delete - create - update type: string processingTime: description: The amount of time elapsed, in milliseconds, from the submission to the completion of the bulk job. example: 550 type: integer recordsProcessed: description: The number of object records processed by the bulk job. example: 1000 type: integer status: description: | The status of the bulk job: - `accepted` - The job has been accepted and is ready to process. - `pending` - The job is waiting for your input. You can use [Upload a file for a custom object bulk job](https://developer.zuora.com/api-references/api/operation/POST_UploadFileForCustomObjectBulkJob) to upload a file so that the job can start creating records. - `in_progress` - The job is processing. - `completed` - The job has completed. - `failed` - The job was unable to complete. You can use [List all errors for a custom object bulk job](https://developer.zuora.com/api-references/api/operation/GET_CustomObjectBulkJobErrors) to list the errors. - `cancelled` - The job was cancelled by the server. enum: - accepted - pending - in_progress - completed - failed - cancelled example: failed type: string type: object CustomObjectBulkDeleteFilter: description: Filters to determine which records to be deleted in the bulk delete operation. properties: conditions: description: Group of field filter conditions that are evaluated in conjunction with each other using the AND operator. The minimum number of conditions is 1 and the maximum is 2. items: $ref: '#/components/schemas/CustomObjectBulkDeleteFilterCondition' type: array required: - conditions type: object CustomObjectBulkDeleteFilterCondition: description: Condition evaluated on a single object field properties: field: description: The object field that is evaluated. Only filterable fields can be evaluated in the filter. example: CreatedDate type: string operator: enum: - EQ - GT - LT - GE - LE example: LT type: string value: description: The value that the filterable `field` is evaluated against in the filter. The data type of `value` is consistent with that of the `field`. example: '2020-01-01T00:00:00.000Z' required: - field - operator - value type: object CustomObjectBulkJobResponseCollection: properties: count: description: The number of custom object bulk jobs returned in the result page set. example: 2 type: integer cursor: description: The `cursor` points to the last job record of the current page. example: a9e9a58d-0a11-4685-b1ab-99521dbc20a1 type: string jobs: description: All custom object bulk jobs returned in the result page set. example: - CreatedById: 2c92c0f96a07409d016a0a58ab1172ec CreatedDate: '2021-03-10T00:05:54.207Z' Id: 5112347a-f7a1-4373-99df-c082984de7be UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec UpdatedDate: '2021-03-10T00:08:15.614Z' namespace: default object: vehicle operation: create processingTime: 62 recordsProcessed: 3 status: completed - CreatedById: 2c92c0f96a07409d016a0a58ab1172ec CreatedDate: '2021-03-09T22:27:59.503Z' Id: a9e9a58d-0a11-4685-b1ab-99521dbc20a1 UpdatedById: 2c92c0f96a07409d016a0a58ab1172ec UpdatedDate: '2021-03-09T22:27:59.503Z' namespace: default object: vehicle operation: create processingTime: 0 recordsProcessed: 0 status: pending items: $ref: '#/components/schemas/CustomObjectBulkJobResponse' type: array required: - jobs type: object CustomObjectBulkJobErrorResponseCollection: properties: errors: description: All errors for a custom object bulk job. items: $ref: '#/components/schemas/CustomObjectBulkJobErrorResponse' type: array required: - errors type: object CustomObjectBulkJobErrorResponse: properties: code: description: The error code. example: 71012520 format: Int32 type: integer message: description: The error message. example: input string "123" is not a valid UUID type: string record: $ref: '#/components/schemas/CustomObjectRecordWithAllFields' row: description: The CSV record row number. The custom object record data starts at the second row because the first row is the CSV header. example: 12 format: Int32 type: integer type: object GetDataQueryJobsResponse: properties: data: description: | List of data query jobs. The query jobs are listed in reverse order of creation. items: $ref: '#/components/schemas/DataQueryJob' type: array type: object DataQueryJob: allOf: - $ref: '#/components/schemas/DataQueryJobCommon' - properties: dataFile: description: | The URL of the query results. Only applicable if the value of the `queryStatus` field is `completed`. format: URL type: string outputRows: description: | The number of rows the query results. Only applicable if the value of the `queryStatus` field is `completed`. type: integer processingTime: description: | Processing time of the query job, in milliseconds. Only applicable if the value of the `queryStatus` field is `completed`. type: integer queryStatus: description: | Status of the query job. * `submitted` - query submitted to query service for processing * `accepted` - query accepted by the query service * `in_progress` - query executed by the query service * `completed` - query execution completed by the query service * `failed` - query unable to be processed by the query service * `cancelled` - query cancelled by the user If the value of this field is `completed`, the `dataFile` field contains the location of the query results. If the value of this field is `accepted` or `in_progress`, you can use [Cancel a data query job](#operation/DELETE_DataQueryJob) to prevent Zuora from performing the query. Zuora then sets the status of the query job to `cancelled`. enum: - submitted - accepted - in_progress - completed - failed - cancelled type: string type: object description: | A data query job. title: queryJob DataQueryJobCommon: properties: createdBy: description: | The query job creator's Id. format: uuid maxLength: 64 minLength: 64 type: string id: description: | Internal identifier of the query job. format: uuid maxLength: 64 minLength: 64 type: string query: description: | The query that was submitted. type: string remainingRetries: description: | The number of times that Zuora will retry the query if Zuora is unable to perform the query. type: integer sourceData: description: | Indicates the source that data queries run against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see Zuora Warehouse. type: string updatedOn: description: | Date and time when the query job was last updated, in ISO 8601 format. format: date-time type: string useIndexJoin: description: | Indicates whether to use Index Join. See Index Join for more information. type: boolean type: object SubmitDataQueryRequest: example: query: SELECT accountnumber, balance FROM Account WHERE Account.balance > 100 compression: NONE output: target: S3 outputFormat: CSV properties: columnSeparator: description: | The column separator. Only applicable if the `outputFormat` is `DSV`. type: string compression: description: | Specifies whether Zuora compresses the query results. enum: - NONE - GZIP - ZIP type: string encryptionKey: description: | Base-64 encoded public key of an RSA key-pair. Note that Data Query only supports 1024-bit RSA keys. If you set this field, Zuora encrypts the query results using the provided public key. You must use the corresponding private key to decrypt the query results. format: byte type: string output: description: | Additional information about the query results. properties: target: description: | Set this field to `S3`. enum: - S3 type: string required: - target type: object outputFormat: description: | Specifies the format of the query results. * `JSON` - Each row in the query results will be a JSON object. The format of the query result file is [JSON Lines](http://jsonlines.org/). * `CSV` - Each row in the query results will be a comma-separated list of values. * `TSV` - Each row in the query results will be a tab-separated list of values. * `DSV` - Pass any character as your custom delimiter into the `columnSeparator` field. enum: - JSON - CSV - TSV - DSV type: string query: description: | The query to perform. See [SQL Queries in Data Query](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/BA_SQL_Queries_in_Data_Query) for more information. type: string readDeleted: default: false description: | Indicates whether the query will retrieve only the deleted record. If `readDeleted` is set to `false` or it is not included in the request body, the query will retrieve only the non-deleted records. If it is set to `true`, only the deleted records will be retrieved. If you select the `deleted` column in the `query` field, both non-deleted and deleted records will be retrieved regardless of the value in the `readDeleted` field. Note that Data Query is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through Data Query. type: boolean sourceData: description: | Specify the source that data queries run against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. This option is available only if you have the Zuora Warehouse feature enabled in your tenant. For more information, see Zuora Warehouse.
If this option is selected, you can specify warehouse size in `warehouseSize`. If this field is not specified, the default value `LIVE` will be used. enum: - LIVE - WAREHOUSE type: string useIndexJoin: description: Indicates whether to use Index Join. Index join is useful when you have a specific reference value in your WHERE clause to index another large table by. See [Use Index Join](https://knowledgecenter.zuora.com/DC_Developers/BA_Data_Query/Best_practices_of_Data_Query#Use_Index_Join) for more information. type: boolean warehouseSize: description: | Specify the size of Zuora Warehouse. This field is available only if the `sourceData` is `WAREHOUSE`. If this field is not specified or set to `NULL`, the default value `xsmall` will be used. enum: - xsmall - 'NULL' type: string required: - query - outputFormat - compression - output type: object SubmitDataQueryResponse: properties: data: $ref: '#/components/schemas/DataQueryJob' type: object DataQueryErrorResponse: properties: code: description: | Error code. type: integer message: description: | Error message. type: string type: object DeleteDataQueryJobResponse: properties: data: $ref: '#/components/schemas/DataQueryJobCancelled' type: object DataQueryJobCancelled: allOf: - $ref: '#/components/schemas/DataQueryJobCommon' - properties: queryStatus: description: | Status of the query job. enum: - cancelled type: string type: object description: | A cancelled data query job. title: cancelledQueryJob GetDataQueryJobResponse: properties: data: $ref: '#/components/schemas/DataQueryJob' type: object SubmitBatchQueryRequest: example: queries: - query: select AccountNumber, BillCycleDay from Account type: zoql properties: dateTimeUtc: description: | When using WSDL 69 and later you can ensure that the exported output of dateTime records are rendered according to ISO-8601 generic UTC form by setting `dateTimeUtc` to `true`. When `dateTimeUtc` is set to `true`, exports of dateTime data types will be rendered in the following generic format: `YYYY-MM-DDThh:mm:ss-hhmm` or `YYYY-MM-DDThh:mm:ss+hhmm`. **Note**: Regardless of what batchType query is used (`zoql` or `zoqlexport`), the query response output for datetime data types can be standardized by setting dateTimeUtc to `true`. When `true`, the results will display datetime types with the format: YYYY-MM-DDThh:mm:ss+/-hhmm. type: boolean format: description: | The format of the query. The default value is `csv`. enum: - csv - zip - gzip type: string incrementalTime: description: | Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the `incrementalTime` parameter. For example, if you set `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally. The time zone of `incrementalTime` depends on which Zuora data center you use. For US Data Center customers, the time zone of `incrementalTime` is Pacific Time. For EU Data Center customers, the time zone of `incrementalTime` is UTC. If the time zone of your system is different from the time zone of `incrementalTime`, you will need to convert to the appropriate time zone before setting `incrementalTime`. **Note**: This field can only be used in Stateful AQuA mode. format: dateTime type: string name: description: | The name of the job. 32 character limit. type: string notifyUrl: description: | If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done. If you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already configured a callout notification through the Zuora user interface. type: string nullReplacement: description: | The string used to represent null values in the query results. If you do not set this parameter, null values are represented by the empty string in the query results. type: string offset: default: 0 description: | This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds. For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM. The value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**. type: integer partner: description: | The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with "project" field to uniquely identify a data integration target. For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices. **Note**: Submit a request at Zuora Global Support to obtain a partner ID. type: string project: description: | The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days. This field must be used together with partner field to uniquely identify a data integration target. This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. type: string queries: description: | A JSON array object that contains a list of batch objects. items: $ref: '#/components/schemas/BatchQuery' required: - name - query type: array sourceData: description: | Specify the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). If this field is not specified, the default value `LIVE` will be used. enum: - LIVE type: string useQueryLabels: description: | When this optional flag is set to `true` the request will use object and field API names for the CSV header output instead of the field labels. Data integration projects should set `useQueryLabels` to `true` so that API names remain the same. By default `useQueryLabels` is `false`, so that output CSV headers display the more user-friendly object and field labels. type: boolean version: description: | The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See Stateless and stateful modes for more information. format: float type: number type: object SubmitBatchQueryResponse: properties: batches: description: | A JSON array object that contains a list of batch objects. items: $ref: '#/components/schemas/BatchesQueries' required: - name - query - status - batchId - batchType type: array encrypted: description: | If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents. enum: - pgp - none type: string format: description: | The format of the query. The default value is `csv`. enum: - csv - zip - gzip type: string id: description: | The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null. type: string incrementalTime: description: | Allows you to override the time from which a Stateful AQuA job incrementally retrieves records that have been created or modified, using the `incrementalTime` parameter. For example, if you set `incrementalTime` = `2015-01-21 10:30:01`, AQuA will retrieve records that have created or modified beginning at 10:30:01. If this parameter is not set, AQuA continues to use the Start Time of the last AQuA session to retrieve records incrementally. The time zone of `incrementalTime` depends on which Zuora data center you use. For US Data Center customers, the time zone of `incrementalTime` is Pacific Time. For EU Data Center customers, the time zone of `incrementalTime` is UTC. If the time zone of your system is different from the time zone of `incrementalTime`, you will need to convert to the appropriate time zone before setting `incrementalTime`. **Note**: This field can only be used in Stateful AQuA mode. format: dateTime type: string name: description: | The name of the job. 32 character limit. type: string notifyUrl: description: | If URL is provided, the AQuA job will call this `notifyUrl` once the job has completed. The value of `notifyUrl` needs to have `${JOBID}` and `${STATUS}` placeholders. These placeholders will be replaced by the actual job ID and status when returned in the response. Status will be `Completed` after the AQuA job is done. If you submit an AQuA query with `notifyUrl` specified, the value of `notifyUrl` will be ignored if your organization has already configured a callout notification through the Zuora user interface. type: string offset: default: 0 description: | This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds. For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM. The value of this field will override the value you configured in **Settings** > **Administration** > **AQuA API Stateful Mode Time Offset**. type: integer partner: description: | The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with "project" field to uniquely identify a data integration target. For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices. **Note**: Submit a request at Zuora Global Support to obtain a partner ID. type: string project: description: | The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days. This field must be used together with partner field to uniquely identify a data integration target. This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. type: string sourceData: description: | Indicates the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). type: string status: description: | The status of the AQuA job: - submitted: The AQuA job was submitted to the query executor for processing. - executing: The AQuA job is being processed. - completed: The AQuA job was successfully executed. - error: The AQuA job was not processed because of validation errors. - aborted: The AQuA job execution failed because one or more queries of this job failed. - cancelled: The AQuA job was cancelled. enum: - submitted - executing - completed - error - aborted - cancelled type: string useLastCompletedJobQueries: description: | If this flag is set to `true`, then all the previous queries are merged with existing queries. If the flag is set to `false`, then the previous queries are ignored, and only the new query is executed. type: boolean version: description: | The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See Stateless and stateful modes for more information. format: float type: number type: object BatchesQueries: properties: apiVersion: description: | The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API. **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields. type: string batchId: description: | A 32-character ID of the query batch. type: string batchType: description: | The kind of batch job being submitted. enum: - zoql - zoqlexport type: string deleted: description: | This field indicates that the AQuA incremental load will retrieve deleted records. **Note**: AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA. items: properties: column: description: | Name of the Column in the extracted file that points to the deleted records. type: string format: description: | Can be set to either `Numeric` or `Boolean`. If set to `Numeric`, deleted records are marked as `1`. If set to `Boolean`, deleted records are marked as `true`. type: string title: deletedRecord type: object type: array full: description: | This field indicates a full or incremental load. `True` = Full and `False` = Incremental. type: boolean name: description: | Name of the query supplied in the request. type: string query: description: | The requested query string. type: string recordCount: description: | The number of records included in the query output file. type: string status: description: | The status of the query task: - submitted: The query was submitted to the query executor for processing. - pending: The query was waiting for being processed. - executing: The query is being processed. - completed: The query was successfully executed. - aborted: The query execution failed. - deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records. enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch BatchQuery: properties: apiVersion: description: | The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API. **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields. type: string convertToCurrencies: description: | The currencies that you want to convert transaction amounts into. You can specify any number of currencies. Specify the currencies using their ISO currency codes and separate each currency with a comma, for example, "EUR,GBP,JPY". See Convert Transaction Amounts Into Any Currency for more information and examples. To use this field, you must have Foreign Currency Conversion enabled and you must be using API version 78 or later. type: string deleted: description: | This field indicates that the AQuA incremental load will retrieve deleted records. If you want to export deleted data, this field is required. **Note**: AQuA API is subject to Zuora Data Retention Policy. The retention period of deleted data is 30 days. You can only retrieve deleted data for 30 days through AQuA. items: properties: column: description: | Name of the Column in the extracted file that points to the deleted records. type: string format: description: | Can be set to either `Numeric` or `Boolean`. If set to `Numeric`, deleted records are marked as `1`. If set to `Boolean`, deleted records are marked as `true`. type: string title: deletedRecord type: object type: array name: description: | The query name that can uniquely identify the query in this API request. type: string query: description: | A valid ZOQL query or Export ZOQL query statement. type: string type: description: | The query type. enum: - zoql - zoqlexport type: string title: query GetAggregateQueryJobResponse: properties: batches: description: | A JSON array object that contains a list of batch objects. items: $ref: '#/components/schemas/BatchesQueriesById' required: - name - query - status - batchId - batchType type: array encrypted: description: | If enabled, you must supply the formatting (zip or unzip) first and decrypt it to get the actual contents. enum: - pgp - none type: string format: description: | The format of the query. The default value is `csv`. enum: - csv - zip - gzip type: string id: description: | The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null. type: string name: description: | The name of the job. 32 character limit. type: string partner: description: | The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with "project" field to uniquely identify a data integration target. For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as "Salesforce", and "project" as "00170000011K3Ub." This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. **Note**: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See Bulk data extraction from Zuora using AQuA for best practices. **Note**: Submit a request at Zuora Global Support to obtain a partner ID. type: string project: description: | The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days. This field must be used together with partner field to uniquely identify a data integration target. This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. type: string sourceData: description: | Indicates the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see Zuora Warehouse. type: string startTime: description: | The start time of the query. type: string status: description: | The status of the AQuA job: - submitted: The AQuA job was submitted to the query executor for processing. - executing: The AQuA job is being processed. - completed: The AQuA job was successfully executed. - error: The AQuA job was not processed because of validation errors. - aborted: The AQuA job execution failed because one or more queries of this job failed. - cancelled: The AQuA job was cancelled. enum: - submitted - executing - completed - error - aborted - cancelled type: string version: description: | The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See Stateless and stateful modes for more information. format: float type: number type: object BatchesQueriesById: properties: apiVersion: description: | The API version for the query. If an API version is not specified, the latest version is used by default. Using the latest WSDL version is most useful for reporting use cases. For integration purposes, specify the WSDL version to ensure consistent query behavior, that is, what is supported and included in the response returned by the API. **Note**: As of API version 69 and later, Zuora changed the format of certain fields. See Date Field Changes in the SOAP API for more information and a list of affected fields. type: string batchId: description: | A 32-character ID of the query batch. type: string batchType: description: | The kind of batch job being submitted. enum: - zoql - zoqlexport type: string fileId: description: | The ID of the query results file. Use Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. type: string full: description: | This field indicates a full or incremental load. `True` = Full and `False` = Incremental. type: boolean message: description: | The error message. maximum: 2048 type: string name: description: | Name of the query supplied in the request. type: string query: description: | The requested query string. type: string recordCount: description: | The number of records included in the query output file. type: string segments: description: | Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if File Segmentation is enabled. Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. type: array items: {} status: description: | The status of the query task: - submitted: The query was submitted to the query executor for processing. - pending: The query was waiting for being processed. - executing: The query is being processed. - completed: The query was successfully executed. - aborted: The query execution failed. - deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records. enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch DeleteBatchQueryJobResponse: properties: batches: description: | A JSON array object that contains a list of batch objects. items: $ref: '#/components/schemas/BatchQueries' required: - name - query - status - batchId - batchType type: array format: description: | The format of the query. The default value is `csv`. enum: - csv - zip - gzip type: string id: description: | The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null. type: string name: description: | The name of the job. 32 character limit. type: string sourceData: description: | Indicates the source this aggregate query runs against: * `LIVE` represents the live transactional databases at Zuora (Data Query Live). * `WAREHOUSE` represents Zuora Warehouse, which has better performance and fewer limitations than the live transactional database. For more information, see Zuora Warehouse. type: string status: description: | The status of the AQuA job: - submitted: The AQuA job was submitted to the query executor for processing. - executing: The AQuA job is being processed. - completed: The AQuA job was successfully executed. - error: The AQuA job was not processed because of validation errors. - aborted: The AQuA job execution failed because one or more queries of this job failed. - cancelled: The AQuA job was cancelled. enum: - submitted - executing - completed - error - aborted - cancelled type: string version: description: | The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See Stateless and stateful modes for more information. format: float type: number type: object BatchQueries: properties: batchId: description: | A 32-character ID of the query batch. type: string batchType: description: | The kind of batch job being submitted. enum: - zoql - zoqlexport type: string fileId: description: | The ID of the query results file. Use Get Results Files to download the query results file. The query results file is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. type: string message: description: | The error message. maximum: 2048 type: string name: description: | Name of the query supplied in the request. type: string query: description: | The requested query string. type: string recordCount: description: | The number of records included in the query output file. type: string segments: description: | Array of IDs of query results files. Replaces fileId for full data loads in stateful mode if File Segmentation is enabled. Use Get Results Files to download each query results file. Each query results file contains at most 500,000 records and is formatted as requested in the batch job. Supported formats are CSV, GZIP, and ZIP. type: array items: {} status: description: | The status of the query task: - submitted: The query was submitted to the query executor for processing. - pending: The query was waiting for being processed. - executing: The query is being processed. - completed: The query was successfully executed. - aborted: The query execution failed. - deleted_notallowed: The query execution failed because objects included in the query do not support the querying of deleted records. enum: - submitted - pending - executing - completed - aborted - deleted_notallowed type: string title: batch JsonNode: description: Json node object contains metadata. title: JsonNode type: object ConfigTemplateErrorResponse: example: reasons: - code: ObjectNotFound message: Configuration Templates does not exist. properties: reasons: items: properties: code: description: | The error code of response. type: string message: description: A detailed description of the error response. type: string type: object type: array type: object CompareSchemaInfoResponse: description: When Tenant's Compare API returns a result, this object is used to send the response to UI. properties: customFields: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array customObjects: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array dataAccessControl: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array metaData: $ref: '#/components/schemas/JsonNode' notifications: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array productCatalog: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array settings: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array workflows: items: $ref: '#/components/schemas/CompareSchemaKeyValue' type: array title: CompareSchemaInfoResponse type: object CompareSchemaKeyValue: description: When a comparison is made between a source and target tenant, it sends a response to the user interface. properties: difference: additionalProperties: items: type: string type: array description: Returns the different components list. type: object response: description: Provides the total reponse of the components. items: $ref: '#/components/schemas/MigrationComponentContent' type: array segregationKeys: description: Provides separation of components. items: type: string type: array title: CompareSchemaKeyValue type: object MigrationComponentContent: description: When a comparison is made between a source and target tenant, it sends a response to the user interface. properties: attribute: type: string componentType: description: Type of selected components to be migrated. type: string currentTargetResponse: $ref: '#/components/schemas/JsonNode' description: type: string disabled: type: string errorMessage: description: Error information. type: string httpMethods: type: string id: type: string key: type: string migratedOn: description: It is the time when migration is triggered. format: date-time type: string migrationId: description: Migration ID. It is generated at the time of triggering deployment. type: string pathPattern: description: PathPattern of component. type: string previousTargetResponse: $ref: '#/components/schemas/JsonNode' result: description: Returns the result details of Components. type: string segregationKey: description: Displays the differences between components. type: string sourceResponse: $ref: '#/components/schemas/JsonNode' status: description: Returns the status of each component. type: string updateStatus: description: Updated Status. type: string title: MigrationComponentContent type: object TemplateMigrationClientRequest: description: | Request to add a new Template migration. TemplateMigrationClientRequest object contains request details of target tenant, source tenant, and template information needed for migration. properties: comments: type: string description: description: Description of the migration. example: Migration from/to Sandbox type: string emailIds: description: List of Emails with comma separator. example: abcd@zuora.com,xyz@zuora.com type: string entityUuid: description: Entity UUID example: 11111 type: string metaData: $ref: '#/components/schemas/JsonNode' name: description: Name of the migration. example: Job A type: string request: description: List of settings need to be migrated. example: ST 4 items: $ref: '#/components/schemas/MigrationComponentContent' type: array sendEmail: description: Flag determines whether or not to send an email. example: true type: boolean required: - description - entityUuid - name - sendEmail title: TemplateMigrationClientRequest type: object MigrationClientResponse: description: Response after migration is added. properties: emailIds: description: 'List of Emails with comma separator ' type: string environment: description: Environment information type: string id: description: Variable to hold the job ID. type: string migratedBy: description: User responsible for migration. example: Jane Cooper type: string migrationDescription: description: Description of the migration. example: Migration from/to Sandbox type: string migrationEnd: description: Timestamp when migration ended. example: '2020-11-01 18:00:00' type: string migrationName: description: Name of the migration. example: Job A type: string migrationStart: description: Timestamp when migration started. example: '2020-11-01 18:00:00' type: string response: items: $ref: '#/components/schemas/MigrationComponentContent' type: array sourceTenantDescription: description: Source Tenant Description. example: Duno type: string sourceTenantName: description: Source Tenant Name. example: Duno type: string status: description: Status of the Migration Job. example: IN PROGRESS type: string type: type: string required: - id - migratedBy - migrationDescription - migrationEnd - migrationName - migrationStart - sourceTenantDescription - sourceTenantName - status title: MigrationClientResponse type: object SettingSourceComponentResponse: description: Provides details about the different components that need to be compared and deployed. properties: customFields: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array customObjects: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array dataAccessControl: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array notifications: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array productCatalog: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array settings: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array workflows: items: $ref: '#/components/schemas/SettingComponentKeyValue' type: array title: SettingSourceComponentResponse type: object SettingComponentKeyValue: description: Provides details about the individual components that need to be compared and deployed. properties: errors: items: type: string type: array originalPayload: $ref: '#/components/schemas/JsonNode' response: items: $ref: '#/components/schemas/ConfigurationTemplateContent' type: array segregationKeys: items: type: string type: array title: SettingComponentKeyValue type: object ConfigurationTemplateContent: description: It contains information about template schemas with segregation keys. properties: componentType: description: Type of Component. type: string error: description: Error Information. type: string id: description: Id of Each component. type: string key: description: Key value of fields inside component. type: string method: description: Http method which is used to retrieve the particular component. type: string payload: $ref: '#/components/schemas/JsonNode' result: description: Contains the response of details fetched regarding selected component. type: string segregationKey: description: Gives the difference between components and sub components. type: string templateId: description: Id of the Template. type: string url: description: Metadata is retrieved from this URL. type: string title: ConfigurationTemplateContent type: object TemplateResponse: description: It contains a collection of all the templates that have been created. properties: templates: description: Contains list of template details. items: $ref: '#/components/schemas/TemplateDetailResponse' type: array title: TemplateResponse type: object TemplateDetailResponse: description: Contains all template details. properties: active: description: Whether or not the template is active. type: boolean content: $ref: '#/components/schemas/SettingSourceComponentResponse' createdBy: description: Information about the user who created it. type: string createdOn: description: When it is created. type: string description: description: Template description which contains the information about the created template. type: string entityName: description: Name of the Entity type: string environment: description: Details of the environment in which the template was created. type: string errors: description: Error information. type: string id: description: Id of the template. type: string name: description: Name of the template. type: string status: description: The status of the template creation, such as whether it is in progress, completed, or failed. type: string tenantName: description: Tenant's name for whom the template is created. type: string title: TemplateDetailResponse type: object CreateTemplateRequestContent: description: | CreateTemplateRequestContent object contains information for creating template. properties: content: $ref: '#/components/schemas/SettingSourceComponentResponse' customFields: description: Selected custom fields component or not. type: boolean customObjects: description: Selected custom objects component or not. type: boolean description: description: Creates template description. type: string name: description: Name of the Template. type: string notifications: description: Selected Notification component or not. type: boolean selectedComponents: description: ConfigurationTemplateContent object contains the selected meta data information. items: $ref: '#/components/schemas/ConfigurationTemplateContent' type: array settings: description: Selected Settings component or not. type: boolean templateTenant: description: ID of the template tenant. example: 80b3f8cd-5801-4ed7-bee7-ad1569916c2f type: string workflows: description: Selected Workflow component or not. type: boolean required: - description - name - templateTenant title: CreateTemplateRequestContent type: object SyncDeploymentTemplateRequest: description: Request schema for syncing a deployment template to another tenant. type: object properties: templateId: type: string description: The ID of the deployment template to be synced. example: f7849a41-8a3b-4cd2-8ec0-c9d225d7720b targetTenantId: type: string description: The ID of the target tenant to which the template should be synced. example: 4d6ab8fc-4faa-4ef2-a9ec-3b90bf3f3ddf required: - templateId - targetTenantId DeploymentManagerResponse: type: object properties: id: type: string description: ID of the Deployment Manager migration process status: type: string description: Status of the Deployment Manager migration process enum: - DEPLOYING - REVERTING - PARTIALLY-REVERTED - FAILED - ROLLBACK-FAILED - REVERTED - COMPARING - SUBMITTED - SKIPPED - IDENTICAL - COMPARE-DONE - COMPARE-FAILED - CANCELLED BulkJobRequest: type: object required: - name - objectType properties: name: type: string description: Name of the job. Max length is 255 characters objectType: type: string description: |- Type of the object. Supported object types: - `account` - `accountingcode` - `accountingperiod` - `amendment` - `bill-run` - `bill-run-batches` - `bill-run-filters` - `contact` - `credit-memo` - `credit-memo-from-charge` - `credit-memo-from-invoice` - `debit-memo` - `debit-memo-from-charge` - `debit-memo-from-invoice` - `invoice` - `journal-entry` - `journal-run` - `offer` - `omni-channel-subscription` - `order` - `order-create-order-line-item` - `order-create-subscription-existing-account` - `order-create-subscription-existing-account-with-volume-charge` - `order-create-subscription-with-new-account` - `order-remove-product` - `order-update-subscription-add-product` - `order-update-subscription-change-plan` - `order-update-subscription-price-quantity-change` - `payment` - `payment-profile` - `payment-schedule` - `payment-schedule-item` - `payments-simple` - `payments-unapply` - `price-book-item` - `product` - `product-charge-definition` - `product-rate-plan` - `product-rate-plan-charge` - `product-rate-plan-charge-tier` - `product-rate-plan-definition` - `refund` - `revenue-accounting-code` - `subscription` - `subscription-add-rate-plan` - `subscription-change-rate-plan` - `subscription-remove-rate-plan` - `subscription-update-rate-plan` - `taxation-item` - `unitofmeasure` - `usage` description: type: string description: Short description of the job. Max length is 255 characters mappings: type: array description: List of mappings. Each mapping maps a source field to a target field in the object. If the field is an array, the type and arrayType must be specified. items: type: object required: - source - target properties: source: type: string description: Source field name target: type: string description: Target field name type: type: string description: Field type enum: - array - string - number - boolean arrayType: type: string description: Type of objects in the array if the field is an array type enum: - string - number - boolean headers: type: array description: List of headers in the source file. Required if the source file does not have a header row. items: type: string rowIdHeader: type: string description: Header in the source file that contains the row id. delimiter: type: string description: |- Delimiter used in the source file. Default is comma. Supported values: comma, tab, pipe, semicolon, colon, caret, tilde, dot/period hasHeaders: type: boolean description: Indicates if the source file has a header row. Default is false fileType: type: string description: |- Type of the source file. Supported values: csv, jsonl Default is csv, which means delimited file where the delimiter can be comma but can also be one of the other supported delimiters enum: - csv - jsonl jobType: type: string description: Type of the bulk job being created. Default is IMPORT enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean description: Indicates if the object type is a custom object. Default is false customObjectNamespace: type: string description: Namespace of the custom object. Applicable only when isCustomObject is true. Default namespace is 'default'. dataSourceType: type: string description: The data source type of the job readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string description: The system type for the job readOnly: true enum: - BILLING CreateResponse: type: object properties: id: type: string format: uuid description: Unique identifier for the job uploadUrl: type: string description: URL to upload the file. This is the URL to which the file should be uploaded using a PUT request. uploadRequest: type: object properties: uri: type: string format: uri description: URL to which the file must be uploaded. fields: type: object description: Form fields required to complete the S3 file upload. additionalProperties: type: string status: type: string description: Status of the job enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading jobType: type: string description: Type of the job enum: - Import - Delete - Update - Cancel SubmitBulkJobResponse: type: object properties: id: type: string format: uuid description: Unique identifier for the job uploadUrl: type: string description: URL to upload the file. This is the URL to which the file should be uploaded using a PUT request. uploadRequest: $ref: '#/components/schemas/UploadRequest' status: type: string description: Status of the job enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading jobType: type: string description: Type of the job readOnly: true enum: - Import - Delete - Update - Cancel UploadRequest: type: object description: Information required to upload the file to S3. properties: uri: type: string format: uri description: URL to which the file must be uploaded. fields: type: object description: Form fields to include in the upload request. additionalProperties: type: string QueryJobSummaryResponse: type: object properties: id: type: string format: uuid description: Unique identifier for the job readOnly: true name: type: string description: Name of the job readOnly: true description: type: string description: Description of the job readOnly: true createdAt: type: integer format: int64 description: Time the job was created readOnly: true createdBy: type: string description: User who created the job readOnly: true status: type: string description: Status of the job readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading rowCount: type: integer format: int32 description: Number of rows in the job readOnly: true rowsSucceeded: type: integer format: int32 description: Number of rows that succeeded in the job readOnly: true rowsFailed: type: integer format: int32 description: Number of rows that failed in the job readOnly: true lastUpdatedAt: type: integer format: int64 description: Time the job was last updated readOnly: true failureReason: type: string description: Reason the job failed readOnly: true objectType: type: string description: Type of object the job is for readOnly: true jobType: type: string description: Type of job readOnly: true enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean description: Whether the job is for a custom object readOnly: true customObjectNamespace: type: string description: Namespace of the custom object the job is for readOnly: true dataSourceType: type: string description: Type of data source the job is for readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string description: Type of system the job is for readOnly: true enum: - BILLING fileType: type: string description: Type of the source file readOnly: true enum: - csv - jsonl IdStatusResponse: type: object properties: id: type: string format: uuid description: Unique identifier for the job readOnly: true status: type: string description: Status of the job readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading DownloadsResponse: type: object properties: jobId: type: string format: uuid description: Unique identifier for the job. readOnly: true status: type: string description: Status of the job. enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading readOnly: true sourceFile: type: string description: Source file URL. readOnly: true errorRowsFile: type: string description: URL for the file containing rows that failed. readOnly: true successRowsFile: type: string description: URL for the file containing successfully processed rows. readOnly: true delimiter: type: string description: Delimiter used in the source file (e.g., comma or pipe). readOnly: true GetSummariesResponse: type: object properties: data: type: array description: List of job summaries readOnly: true items: type: object properties: id: type: string format: uuid description: Unique identifier for the job readOnly: true name: type: string description: Name of the job readOnly: true status: type: string description: Status of the job readOnly: true enum: - Created - Submitted - In Progress - Aborting - Completed - Failed - Aborted - Cancelled - Downloading description: type: string description: Description of the job readOnly: true createdAt: type: integer format: int64 description: Time the job was created readOnly: true createdBy: type: string description: User who created the job readOnly: true submittedAt: type: integer format: int64 description: Time the job was submitted readOnly: true submittedBy: type: string description: User who submitted the job readOnly: true rowCount: type: integer format: int32 description: Number of rows in the job readOnly: true rowsSucceeded: type: integer format: int32 description: Number of rows that succeeded in the job readOnly: true rowsFailed: type: integer format: int32 description: Number of rows that failed in the job readOnly: true lastUpdatedAt: type: integer format: int64 description: Time the job was last updated readOnly: true failureReason: type: string description: Reason the job failed readOnly: true objectType: type: string description: Type of object the job is for readOnly: true jobType: type: string description: Type of job readOnly: true enum: - Import - Delete - Update - Cancel isCustomObject: type: boolean description: Whether the job is for a custom object readOnly: true customObjectNamespace: type: string description: Namespace of the custom object the job is for readOnly: true dataSourceType: type: string description: Type of data source the job is for readOnly: true enum: - UserUpload - Salesforce - Chargebee - Stripe systemType: type: string description: Type of system the job is for readOnly: true enum: - BILLING fileType: type: string readOnly: true enum: - csv - jsonl nextPageCursor: type: string description: Cursor for the next page of results readOnly: true headers: GLOBAL_HEADER_RESPONSE_Zuora_TrackId: schema: type: string maxLength: 64 description: | A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header. GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Type: schema: type: string description: | The type of the concurrency limit, which can be either `Default` or `High-volume transactions`. For more information, see [Concurrent request limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits). GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Limit: schema: type: integer description: | The total number of the permitted concurrent requests. For more information, see [Concurrent request limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits). GLOBAL_HEADER_RESPONSE_Concurrency_Limit_Remaining: schema: type: integer description: | The remaining number of the permitted concurrent requests. For more information, see [Concurrent request limits](https://developer.zuora.com/docs/guides/rate-limits/#concurrent-request-limits). GLOBAL_HEADER_RESPONSE_Zuora_RequestId: schema: type: string minLength: 36 maxLength: 36 description: | The Zuora internal identifier of the API call. You cannot control the value of this header. GLOBAL_HEADER_RESPONSE_Content_Encoding: schema: type: 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` GLOBAL_HEADER_RESPONSE_RateLimit_Limit: schema: type: string description: | The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. GLOBAL_HEADER_RESPONSE_RateLimit_Remaining: schema: type: number description: | The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. GLOBAL_HEADER_RESPONSE_RateLimit_Reset: schema: type: number description: 'The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/docs/guides/rate-limits/) for more information. ' x-tagGroups: - name: Authentication tags: - OAuth - name: Products tags: - Products - Catalog - Catalog Groups - Commerce - 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 - Omnichannel Subscriptions - Subscription Change History - Rate Plans - Commitments - name: Advanced Consumption Billing tags: - Prepaid with Drawdown - name: Usage tags: - Usage - name: Mediation tags: - Meters - name: Billing Documents tags: - Delivery Adjustments - Billing Documents - Invoices - Credit Memos - Debit Memos - E-Invoicing - Invoice Schedules - Taxation Items - Sequence Sets - Operations - Summary Statements - 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 - Payment Profiles - Configurable Payment Retry - name: Object Query tags: - Object Queries - 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 - Tax Health - name: Workflow tags: - Workflows - name: Data Query tags: - Data Queries - name: AQuA tags: - Aggregate Queries - name: Deployment Manager tags: - Configuration Templates - Metadata - name: Data Loader tags: - Bulk Data - name: OneID tags: - SCIM - name: Multiple Organizations tags: - Data Labeling - name: Order to Revenue tags: - Data Backfill - Regenerate - name: Test Environments tags: - Test Environments - Test Environment Jobs - Test Environment Notifications - name: General-Purpose Operations tags: - Actions - Settings - Files - Imports - Custom Exchange Rates - Attachments - Describe