**Note:** The value of this column is optional, but the column header is required.
| No |\n| 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 |\n| 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 |\n| 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 |\n| DESCRIPTION | Enter a description for the charge. | No |\n| 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 |\n","tags":["usage"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTUsageResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The usage data to import. The supported formats are excel, csv, and zip.\n"}},"required":["file"]}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/invoice-item/{invoice-item-id}/usage-rate-detail":{"get":{"operationId":"usage_GET_Usage_Rate_Detail_By_Invoice_Item","summary":"Retrieve usage rate detail for an invoice item","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). \n\n**Notes and limitations:**\n- Do not support the Overage Charge Model, Tiered with Overage Charge Model, and Multi-attribute Pricing Charge Model.\n- Do not support invoices in `Cancelled` or `Reversed` status.\n- Do not support Active rating.\n- 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.\n- Do not support [On-demand usage rating](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Rating/On-demand_Usage_Rating). \n- Tax calculation is not involved.\n","tags":["usage"],"parameters":[{"name":"invoice-item-id","in":"path","description":"Invoice item ID. For example, `402880e57f725d85017f7267c4ad002b`. Available through Data Source export.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETUsageRateDetailWrapper"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/object/usage":{"post":{"operationId":"usage_Object_POSTUsage","summary":"CRUD: Create a usage record","description":"Creates a usage record.","tags":["usage"],"parameters":[{"name":"rejectUnknownFields","in":"query","description":"Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"X-Zuora-WSDL-Version","in":"header","description":"Zuora WSDL version number.\n","required":false,"schema":{"type":"string","default":79}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateOrModifyResponse"}}}},"400":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateUsage"}}}},"security":[{"bearerAuth":[]}]}},"/v1/object/usage/{id}":{"get":{"operationId":"usage_Object_GETUsage","summary":"CRUD: Retrieve a usage record","description":"Retrieve a usage record.","tags":["usage"],"parameters":[{"name":"id","in":"path","description":"Object id","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Object fields to return","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyGetUsage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyNoDataResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"usage_Object_PUTUsage","summary":"CRUD: Update a usage record","description":"Updates a usage record. Updating usage records that are associated with a dynamic pricing usage charge is not supported through this endpoint. The request fails and the record is not updated. Use Mediation-based flows to manage such usage.","tags":["usage"],"parameters":[{"name":"id","in":"path","description":"Object id","required":true,"schema":{"type":"string"}},{"name":"rejectUnknownFields","in":"query","description":"Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateOrModifyResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyModifyUsage"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"usage_Object_DELETEUsage","summary":"CRUD: Delete a usage record","description":"Deletes a usage record. Usage records that are associated with a dynamic pricing usage charge cannot be deleted with this legacy Billing endpoint. When a delete request targets such a record, the operation fails and the usage record is not removed. Operations on dynamic pricing usage are supported only via Mediation-driven flows.","tags":["usage"],"parameters":[{"name":"id","in":"path","description":"Object id","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyDeleteResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/run/{meterId}/{version}":{"post":{"operationId":"meters_runSpecificVersionOfMeter","summary":"Run a specific version of a meter","description":"Executes a specific version of a meter in Zuora Mediation. You can choose to run it with either a local file or event store source by providing optional configurations.\n\n**Note on long-running meters and timeouts:** \nFor large meters with many operators, this API call might take longer to return and, in some cases, can time out even though the meter run has been successfully triggered.\nTo safely handle this, provide a `uniqueKey` field in the request body.\nIf the operation times out, retry the same request with the same `uniqueKey`.\nIf the original run already exists, the API returns a 400 error indicating a duplicate `uniqueKey` instead of creating a new run. \n","tags":["meters"],"parameters":[{"name":"meterId","in":"path","description":"The ID of the meter to run. You can find this ID in the Zuora Mediation UI URL when viewing a meter.","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"The version of the meter to run. Currently, the only supported value is `0.0.1` for all meters. Always pass `0.0.1` in this path parameter.","required":true,"schema":{"$ref":"#/components/schemas/MetersRunMeterIdVersionPostParametersVersion"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful meter run","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunMeterVersionResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunMeterVersionRequest"}}}},"security":[{"bearerAuth":[]}]}},"/meters/debug/{meterId}/{version}":{"post":{"operationId":"meters_testSpecificVersionOfMeter","summary":"Test a specific version of a meter","description":"Test a specific version of a meter in Zuora Mediation without executing a full run. It supports multiple input methods, including uploaded files, sample files, and manual test data. This is useful for validating meter logic and transformations before meter run.","tags":["meters"],"parameters":[{"name":"meterId","in":"path","description":"The ID of the meter to be tested.","required":true,"schema":{"type":"integer"}},{"name":"version","in":"path","description":"The version of the meter to be tested.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successfully tested meter version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSpecificMeterResponse"}}}},"400":{"description":"Bad Request - Invalid or missing parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized - Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSpecificMeterRequest"}}}},"security":[{"bearerAuth":[]}]}},"/meters/{meterId}/summary":{"post":{"operationId":"meters_retrieveMeterSummaryData","summary":"Retrieve summary data for a meter","description":"Retrieves summary data for a specific meter in Zuora Mediation, providing a rolled-up view of a meter run or time window. The API supports grouping by Operator ID, Error Code, or Session ID, and allows optional filters such as Query From Time, Query To Time, Operator IDs, and Session IDs. The API returns aggregated output and error counts per group and includes validation with detailed error responses for invalid parameters or formats.","tags":["meters"],"parameters":[{"name":"meterId","in":"path","description":"The ID of the meter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpecificMeterSummaryResponse"}}}},"400":{"description":"Bad Request - Invalid or missing parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized - Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpecificMeterSummaryRequest"}}}},"security":[{"bearerAuth":[]}]}},"/meters/{meterId}/{version}/runStatus":{"get":{"operationId":"meters_getRunStatusOfSpecificMeterVersion","summary":"Retrieve the run status of a specific meter version","description":"Retrieves the current run status of a specific meter version in Zuora Mediation. It returns an integer code indicating the status, such as `RUNNING`, `COMPLETED`, or `FAILED`, which helps monitor the meter's execution state.","tags":["meters"],"parameters":[{"name":"meterId","in":"path","description":"ID of the meter.","required":true,"schema":{"type":"integer"}},{"name":"version","in":"path","description":"Version of the meter.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful response with run status data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunStatusResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"404":{"description":"Meter not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/export/{meterId}":{"get":{"operationId":"meters_exportSpecificMeter","summary":"Export details of a specific meter","description":"The Export Meter operation exports the full definition of a specific meter in Zuora Mediation, including metadata, all versions, event schemas, and operator configurations (source, processor, sink). It's useful for reviewing, backing up, or replicating meter setups across environments.\n","tags":["meters"],"parameters":[{"name":"meterId","in":"path","description":"ID of the meter to export.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful response with meter export data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMeterResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"404":{"description":"Meter not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/import":{"post":{"operationId":"meters_importMeterDefinition","summary":"Import a meter definition","description":"Import a meter definition into Zuora Mediation using a file exported from the Export Meter API.\n","tags":["meters"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful import of meter definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportMeterResponse"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized access","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Meter definition file, should match format from Export Meter API"},"globalId":{"type":"string","description":"If present and matches an existing meter, updates it. Else, creates a new meter with this globalId."}},"required":["file"]}}}},"security":[{"bearerAuth":[]}]}},"/meters/files":{"post":{"operationId":"dataIngestion_uploadMeteringFile","summary":"Upload a file","description":"Uploads and stores a file in Zuora Mediation for use in meter processing. Supported formats include CSV, Excel, and JSON. You can specify metadata like headers,\n delimiters, sheets, and data ranges.\n","tags":["dataIngestion"],"responses":{"200":{"description":"File successfully uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFileResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file to store"},"hasHeader":{"type":"boolean","description":"Indicates if the file has a header (for CSV/Excel)"},"firstRow":{"type":"integer","description":"Indicates where the first row starts (for CSV format)"},"delimiter":{"type":"string","description":"Delimiter to separate values (for CSV format)"},"sheet":{"type":"string","description":"The sheet where data lives (for Excel)"},"dataRange":{"type":"string","description":"The data range in the sheet (for Excel)"},"resolveFileNameConflict":{"type":"boolean","description":"Whether to generate a UUID file name"},"targetFolder":{"type":"string","description":"The target folder to store the file"},"overwriteExistingFile":{"type":"boolean","description":"Whether to overwrite an existing file"}},"required":["file"]}}}},"security":[{"bearerAuth":[]}]}},"/usage/bulk/{meterGlobalId}":{"post":{"operationId":"dataIngestion_ingestUsageEvents","summary":"Ingest usage events for a meter","description":"Ingests usage events directly into Zuora Mediation in real time. You can send a single event or batch multiple events in a JSON array to optimize throughput. Each event must conform to the meter's event schema. This operation is supported only for meters that use the Streaming API as their source in Zuora Mediation. You can use this API to bulk-ingest events into a meter only when the meter's source is configured as a Streaming API operator. For meters that use other sources, use the appropriate ingestion mechanism for that source instead.\n","tags":["dataIngestion"],"parameters":[{"name":"meterGlobalId","in":"path","description":"The global ID of the meter.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Usage event(s) ingested successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamingIngestionSuccessResponse"}}}},"400":{"description":"Bad request due to validation or business logic errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamingIngestionAuthError"}}}},"404":{"description":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamingIngestionAuthError"}}}},"413":{"description":"Payload too large.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamingIngestionAuthError"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreamingIngestionAuthError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"A JSON object or an array of objects representing usage events. Each event must conform to the event schema defined in your meter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Data_Ingestion_ingestUsageEvents_Request"}}}},"security":[{"bearerAuth":[]}]}},"/meters/{meterId}/auditTrail/entries":{"get":{"operationId":"auditTrail_getAuditTrailEntriesForMeter","summary":"Retrieve the audit trail entries for a meter","description":"Retrieves the audit trail entries for a specific meter in Zuora Mediation. The API provides detailed, record-level information about what happened during processing, including Payload and error details, operator information, and the trace ID/event ID.","tags":["auditTrail"],"parameters":[{"name":"meterId","in":"path","description":"ID of the meter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"exportType","in":"query","description":"Type of the export. `SAMPLE` indicates an export of success records, `ERROR` indicates an export of error records.","required":true,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailEntriesGetParametersExportType"}},{"name":"runType","in":"query","description":"Specifies the type of run. `DEBUG` indicates a test run, `NORMAL` indicates a live run.","required":true,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailEntriesGetParametersRunType"}},{"name":"sessionId","in":"query","description":"A specific session ID.\n","required":false,"schema":{"type":"string"}},{"name":"queryFromTime","in":"query","description":"The minimum timestamp of the audit trail data. The value must be an ISO 8601 timestamp with a numeric timezone offset in the format `YYYY-MM-DDTHH:MM:SS±HHMM`. For UTC, use `+0000`.\n","required":true,"schema":{"type":"string"}},{"name":"queryToTime","in":"query","description":"The maximum timestamp of the audit trail data. The value must be an ISO 8601 timestamp with a numeric timezone offset in the format `YYYY-MM-DDTHH:MM:SS±HHMM`. For UTC, use `+0000`.\n","required":true,"schema":{"type":"string"}},{"name":"operatorId","in":"query","description":"The ID of the operator. The Operator ID is displayed for each operator node, for both current meters and historic runs. On the Mediation UI, click on a test ID or session ID to see the details of the run.\n","required":false,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size for pagination.\n","required":false,"schema":{"type":"integer","maximum":500,"default":30}},{"name":"cursor","in":"query","description":"nextPage token from previous response.\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditTrailResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/{meterId}/auditTrail/export":{"get":{"operationId":"auditTrail_getAuditTrailExportJobs","summary":"Retrieve the list of export jobs for a meter","description":"Retrieves the list of previously initiated export jobs for a specific meter in Zuora Mediation.\nYou can filter the results by export type and session IDs using the `exportType` and `sessionIds`\nquery parameters. Use the returned `status` and `fileList` fields on each job to determine whether\na job is complete and which files to download. Then use the \"Retrieve the presigned URL for an\nexport job\" operation with each `fileKey` in `fileList` to obtain the download URLs.\n","tags":["auditTrail"],"parameters":[{"name":"meterId","in":"path","description":"ID of the meter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"exportType","in":"query","description":"Type of the export. `SAMPLE` indicates an export of success records, `ERROR` indicates an export of error records.","required":false,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailExportGetParametersExportType"}},{"name":"sessionIds","in":"query","description":"The session IDs of the meter run. For example, `R-000001, R-000002`.\n","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"pageSize","in":"query","description":"Page size for pagination.\n","required":false,"schema":{"type":"integer","maximum":100,"default":30}},{"name":"page","in":"query","description":"The page number.\n","required":false,"schema":{"type":"integer","default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAuditTrailExportResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"auditTrail_createAuditTrailExportJob","summary":"Create a job to export audit trail data for a meter","description":"Creates a background job to export the audit trail entries for a specific meter in Zuora Mediation. This API is for large-scale, offline access to audit data. Only one export job is processed per tenant at a time, and each export has a record limit, for example, up to 5 million rows per report. Use the returned requestId with the \"Retrieve the list of export jobs for a meter\" API operation to track the job status and retrieve the generated file names from `fileList`, then download them using the \"Retrieve the presigned URL for an export job\" API operation.","tags":["auditTrail"],"parameters":[{"name":"meterId","in":"path","description":"The ID of the meter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"exportType","in":"query","description":"Type of the export. `SAMPLE` indicates an export of success records, `ERROR` indicates an export of error records.","required":true,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailExportPostParametersExportType"}},{"name":"runType","in":"query","description":"Specifies the type of run. `DEBUG` indicates a test run, `NORMAL` indicates a live run.","required":true,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailExportPostParametersRunType"}},{"name":"sessionIds","in":"query","description":"A list of specific run IDs to export. For example, `R-000001, R-000002`.\n","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"runStatuses","in":"query","description":"Filters audit entries by their run status. If omitted, all statuses are included. Statuses are case-sensitive.\nPossible values:\n - NEVER_RUN\n - TESTING\n - TESTING_FAILED\n - TESTING_PASSED\n - RUNNING\n - PAUSED\n - COMPLETED\n - FAILED\n - CANCELED\n - INITIALIZING\n - USAGE_PUSHING\n - PUSH_COMPLETED\n - CONSUME_COMPLETED \n","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"operatorIds","in":"query","description":"A list of operator IDs to filter by. The Operator ID is displayed for each operator node, for both current meters and historic runs. On the Mediation UI, click on a test ID or session ID to see the details of the run.\n","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"queryFromTime","in":"query","description":"The minimum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.\n","required":true,"schema":{"type":"string"}},{"name":"queryToTime","in":"query","description":"The maximum timestamp for the data to be exported. The standard used is ISO 8601 with timezones.\n","required":true,"schema":{"type":"string"}},{"name":"format","in":"query","description":"Required format for the exported data. \n\nSupported values are:\n- `csv`: Row-based CSV output\n- `parquet`: Columnar Parquet output\n- `avro`: Avro output\n\nIf omitted, `csv` is used by default for backward compatibility.\n","required":false,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailExportPostParametersFormat","default":"csv"}},{"name":"compression","in":"query","description":"Optional compression algorithm applied to the exported file(s).\n\nSupported values are:\n- `none`: No compression (default)\n- `gzip`: GZIP compression\n- `lz4`: LZ4 compression\n- `zstd`: Zstandard compression\n\nIf omitted, `none` is used and the export produces an uncompressed\nfile. When a compression value other than `none` is specified, the\ngenerated export files are stored in compressed form and must be\ndecompressed by the client after download.\n","required":false,"schema":{"$ref":"#/components/schemas/MetersMeterIdAuditTrailExportPostParametersCompression","default":"none"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportAuditTrailResponse"}}}},"400":{"description":"Bad Request - Invalid or missing parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized - Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/auditTrail/presignedUrl":{"get":{"operationId":"auditTrail_getPresignedURLForMeterExport","summary":"Retrieve the presigned URL for an export job","description":"Returns a pre-signed URL that you can use to download a specific export file (usually from object storage such as S3). The `fileKey` corresponds to one entry from the `fileList` array in the List API. Use the returned URL in the data field directly in a browser or via a HTTP client to download the export file.","tags":["auditTrail"],"parameters":[{"name":"fileKey","in":"query","description":"The file key of the export file to download.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPresignedURLResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/{meterId}/prefetchAudit":{"get":{"operationId":"auditTrail_listPrefetchAuditRecords","summary":"List prefetch audit records","description":"List audit records for prefetch operations by processor ID with filtering and cursor-based pagination.","tags":["auditTrail"],"parameters":[{"name":"meterId","in":"path","description":"The ID of the meter.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"operatorId","in":"query","description":"Unique identifier for the processor.","required":true,"schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start date for filtering audit records (inclusive) in YYYY-MM-DD format. If not provided, defaults to 7 days before today (UTC).","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"endDate","in":"query","description":"End date for filtering audit records (inclusive) in YYYY-MM-DD format. If not provided, defaults to today (UTC).","required":false,"schema":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},{"name":"triggerType","in":"query","description":"Filter by trigger type.","required":false,"schema":{"$ref":"#/components/schemas/MetersMeterIdPrefetchAuditGetParametersTriggerType"}},{"name":"status","in":"query","description":"Filter by job status. Repeat this parameter to specify multiple values.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/MetersMeterIdPrefetchAuditGetParametersStatusSchemaItems"}}},{"name":"pageSize","in":"query","description":"Number of records to return per page.","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","description":"Cursor for pagination (obtained from `nextPage` or `previousPage` in the response).","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPrefetchAuditResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/events/bulkDelete":{"post":{"operationId":"eventStore_bulkDeleteEventsFromEventStore","summary":"Bulk delete events from an event store","description":"Allows you to delete multiple events from an event store in Zuora Mediation using a file that lists the event IDs to be removed. It is useful for cleaning up or correcting data in bulk.\n","tags":["eventStore"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful response with query ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteEventResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file that contains the event IDs to delete."},"storeId":{"type":"integer","description":"ID of the event store to delete events from."}},"required":["file","storeId"]}}}},"security":[{"bearerAuth":[]}]}},"/meters/events/stores/{eventStoreId}/jobs/latest":{"get":{"operationId":"eventStore_getLatestQueryJobOfSpecificEventStore","summary":"Retrieve the latest query job of a specific event store","description":"Retrieves the most recent query job executed on a specific event store in Zuora Mediation. It returns metadata such as query type (for example, DELETE), status, record counts, and timestamps.","tags":["eventStore"],"parameters":[{"name":"eventStoreId","in":"path","description":"ID of the event store.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"Successful response with latest event store query job details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LatestEventStoreJobResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"404":{"description":"Event store not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/events/stores/{eventStoreId}/truncate":{"post":{"operationId":"eventStore_truncateEventStore","summary":"Truncate all data from an event store","description":"Truncates (deletes) all events from a specific event store in Zuora Mediation.\n\nThis operation runs asynchronously and returns a query job identifier that\nyou can use with the Event Store query job APIs to monitor status.\n","tags":["eventStore"],"parameters":[{"name":"eventStoreId","in":"path","description":"ID of the event store to truncate.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK - Truncation job successfully submitted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TruncateEventStoreResponse"}}}},"400":{"description":"Bad Request - Invalid eventStoreId parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationTruncateErrorResponse"}}}},"404":{"description":"Not Found - Event Store does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationTruncateErrorResponse"}}}},"409":{"description":"Conflict - Event Store is in a non-modifiable state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationTruncateErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/meters/event-store-queries":{"post":{"operationId":"eventStore_submitEventStoreQuery","summary":"Submit an event store query","description":"Submits a SQL-style asynchronous query to the Event Store to retrieve and inspect metering events for validation, troubleshooting, and reconciliation. The API returns a `queryId` that can be used to poll and fetch paginated results.","tags":["eventStore"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEventStoreQueryResponse"}}}},"400":{"description":"Bad Request - Invalid or missing parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized - Authentication failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MediationErrorResponse"}}}},"500":{"description":"Internal Server Error - Unexpected error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEventStoreQueryRequest"}}}},"security":[{"bearerAuth":[]}]}},"/meters/event-store-queries/{queryId}":{"get":{"operationId":"eventStore_getQueryResultsForEventStore","summary":"Retrieve the results for an event store query","description":"Retrieves paginated result rows and column metadata for a previously submitted Event Store query using its `queryId`, including total row count, row-level field values, and readiness status. Query execution is asynchronous.","tags":["eventStore"],"parameters":[{"name":"queryId","in":"path","description":"ID of the query.","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Page size for page-based pagination of query results.\nMust be used together with the `page` parameter. Maximum 50.\n","required":false,"schema":{"type":"integer","maximum":50,"default":20}},{"name":"page","in":"query","description":"1-based page index for page-based pagination of query results.\nCombine with `pageSize` and the `data` > `totalCount` field in the response\nto iterate through all matching rows.\n","required":false,"schema":{"type":"integer","default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQueryResultsResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/adjustments":{"get":{"operationId":"deliveryAdjustments_GET_Subscription_Adjustments","summary":"List all delivery adjustments of a subscription","description":"Describes how to retrieve detailed information about delivery adjustments of a subscription.\n\n**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.\n","tags":["deliveryAdjustments"],"parameters":[{"name":"subscription-number","in":"query","description":"A subscription number.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETAdjustmentsBySubscriptionNumberResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"deliveryAdjustments_Create_Adjustment","summary":"Create a delivery adjustment","description":"Describes how to create one or more delivery adjustments for a subscription. \n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n- This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “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.\n","tags":["deliveryAdjustments"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETAdjustmentsResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreateBillingAdjustmentRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/adjustments/preview":{"post":{"operationId":"deliveryAdjustments_Preview_Adjustment","summary":"Preview a delivery adjustment","description":"Describes how to preview delivery adjustments of a subscription.\n\n**Notes**: \n- The Delivery Adjustments feature is in the Early Adopter phase. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available. To manage and access this feature through the self-service interface, see [Enable billing features by yourself](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Billing_Settings/Manage_Features) in the Knowledge Center.\n- This operation supports a partial success scenario: when at least one eligible delivery adjustment exists for a given time period, “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.\n","tags":["deliveryAdjustments"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETAdjustmentsResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPreviewBillingAdjustmentRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/adjustments/{adjustment-key}":{"get":{"operationId":"deliveryAdjustments_GET_Adjustment","summary":"Retrieve a delivery adjustment","description":"Describes how to retrieve detailed information about a delivery adjustment.\n\n**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.\n","tags":["deliveryAdjustments"],"parameters":[{"name":"adjustment-key","in":"path","description":"The delivery adjustment ID or number to retrieve.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETAdjustmentByIdResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/adjustments/{adjustmentId}/cancel":{"put":{"operationId":"deliveryAdjustments_PUT_CancelAdjustment","summary":"Cancel a delivery adjustment","description":"Describes how to cancel an unbilled delivery adjustment.\n\n**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.\n","tags":["deliveryAdjustments"],"parameters":[{"name":"adjustmentId","in":"path","description":"The ID of the delivery adjustment to cancel.\n","required":true,"schema":{"type":"string","format":"UUID"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCancelAdjustmentResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelBillingAdjustmentRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/billing-documents":{"get":{"operationId":"billingDocuments_GET_BillingDocuments","summary":"List billing documents for an account","description":"Retrieves the information about all billing documents associated with a specified account. The billing documents contain invoices, credit memos, and debit memos.\n\nTo retrieve information about credit memos and debit memos, you must have the Invoice Settlement feature enabled. \n\nYou can use query parameters to restrict the data returned in the response.\n\nExamples:\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&sort=+documentDate\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1&status=Posted\n- /billing-documents?accountNumber=A00000001&sort=+documentDate\n- /billing-documents?accountNumber=A00000001&status=Posted\n","tags":["billingDocuments"],"parameters":[{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"accountId","in":"query","description":"The ID of the customer account that the billing documents are associated with.\n\n**Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters.\n","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"accountNumber","in":"query","description":"The number of the customer account that the billing documents are associated with.\n\n**Note**: When retrieving information about all billing documents associated with an account, you must specify either `accountId` or `accountNumber` in the query parameters.\n","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"documentDate","in":"query","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.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"The status of the billing document.\n","required":false,"schema":{"$ref":"#/components/schemas/V1BillingDocumentsGetParametersStatus"}},{"name":"sort","in":"query","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nIf you do not specify any sortable field, the response data is sorted by the `documentDate` field in descending order.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field. \n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - documentDate\n - documentType\n\n \nExamples:\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1\n &sort=+documentDate,-documentType\n- /billing-documents?accountId=4028905f5e4feb38015e50af9aa002d1\n &status=Posted&sort=+documentDate&page=2&pageSize=15\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingDocumentQueryResponseElementType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/accounts/billing-documents/files/deletion-jobs":{"post":{"operationId":"billingDocuments_POST_BillingDocumentFilesDeletionJob","summary":"Create a job to hard delete billing document files","description":"Creates an asynchronous job to permanently delete all billing document PDF files for specific accounts. \n\nAfter the deletion job is completed, all billing document PDF files are permanently deleted. To retrieve the status of a deletion job, call [Retrieve a job of hard deleting billing document files](https://developer.zuora.com/api-references/api/operation/GET_BillingDocumentFilesDeletionJob).\n\n**Note**: This operation can be used only if you have the Billing user permission \"Hard Delete Billing Document Files\" enabled. \n","tags":["billingDocuments"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBillingDocumentFilesDeletionJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBillingDocumentFilesDeletionJobRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/accounts/billing-documents/files/deletion-jobs/{jobId}":{"get":{"operationId":"billingDocuments_GET_BillingDocumentFilesDeletionJob","summary":"Retrieve a job of hard deleting billing document files","description":"Retrieves information about an asynchronous job of permanently deleting all billing document PDF files for specific accounts.\n\n**Note**: This operation can be used only if you have the Billing user permission \"Hard Delete Billing Document Files\" enabled. \n","tags":["billingDocuments"],"parameters":[{"name":"jobId","in":"path","description":"The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETBillingDocumentFilesDeletionJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/accounts/{key}/billing-documents/generate":{"post":{"operationId":"billingDocuments_POST_GenerateBillingDocuments","summary":"Generate billing documents by account ID","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.\n\n**Note**: You cannot generate billing documents for cancelled or suspended subscriptions.\n","tags":["billingDocuments"],"parameters":[{"name":"key","in":"path","description":"The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateBillingDocumentResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostGenerateBillingDocumentType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices":{"post":{"operationId":"invoices_POST_StandaloneInvoice","summary":"Create a standalone invoice","description":"Creates a standalone invoice for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\nTo 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.\nSee Billing Roles for more information.\n","tags":["invoices"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostInvoiceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostInvoiceType"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"invoices_PUT_BatchUpdateInvoices","summary":"Update invoices","description":"Updates multiple invoices in batches with one call. The following tutorials demonstrate how to use this operation:\n - Add and delete invoice items of draft standalone invoices\n - Edit due dates of draft standalone invoices\n - Edit invoice item prices and custom fields of draft standalone invoices\n \n\n### Limitations\n\n\n - You can update a maximum of 50 invoices by one call.\n","tags":["invoices"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutBatchInvoiceType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/batch":{"post":{"operationId":"invoices_POST_StandaloneInvoices","summary":"Create standalone invoices","description":"Creates multiple standalone invoices for selling physical goods, services or other items on a non-recurring basis to your subscription customers.\n\n\nTo 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.\nSee Billing Roles for more information.\n\n### Limitations\n\nThis operation has the following limitations:\n\n* You can create a maximum of 50 invoices in one request.\n\n* You can create a maximum of 1,000 invoice items in one request.\n","tags":["invoices"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBatchInvoiceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBatchInvoicesType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/bulk-post":{"post":{"operationId":"invoices_POST_PostInvoices","summary":"Post invoices","description":"Posts multiple invoices.\n\nYou can post a maximum of 50 invoices in one single request. Additionally, you can also update invoice dates while posting the invoices.\n**Note** : This operation is synchronous and invoices within the bulk request are posted one by one. The maximum batch size depends on the posting performance, which varies with invoice complexity and integrations with external tax engines.\n","tags":["invoices"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicesBatchPostResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTInvoicesBatchPostType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/pdf-status":{"get":{"operationId":"invoices_GetInvoicePdfStatus","summary":"Retrieve the PDF file generation status of invoices","description":"Retrieves the PDF generation statuses of a batch of invoices. ","tags":["invoices"],"parameters":[{"name":"invoiceKeys","in":"query","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.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoicePdfStatusBatchResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}":{"get":{"operationId":"invoices_Get_GetInvoice","summary":"Retrieve an invoice","description":"Retrieves a specific invoice.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"invoices_PUT_UpdateInvoice","summary":"Update an invoice","description":"Updates a specific invoice.\nThe following tutorials demonstrate how to use this operation:\n - Add and delete invoice items of draft standalone invoices\n - Edit due dates of draft standalone invoices\n - Edit invoice item prices and custom fields of draft standalone invoices\n \n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutInvoiceResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutInvoiceType"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"invoices_DELETE_DeleteInvoice","summary":"Delete an invoice","description":"Deletes a specific invoice.\n\nWhether 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.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInvoiceResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/cancel":{"put":{"operationId":"invoices_cancelInvoice","summary":"Cancel an invoice","description":"Cancel the invoice synchronously or asynchronously based on the number of invoice \nitems it contains. By default, Zuora cancels invoices with fewer than 1,000 invoice \nitems synchronously and cancels invoices with 1,000 or more invoice items asynchronously. \n\n\nFor invoices with more than 1,000 invoice items, use the `jobStatus` field in the response \nto determine whether the operation is still in progress or has completed. If `jobStatus` is \n`Completed`, the operation has finished. If `jobStatus` is `Pending`, the operation is still \nin progress, and you must check the job status later to confirm completion. \n\n\n**Note:** To change this threshold, submit a request to Zuora Global Support\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelInvoiceResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/application-parts":{"get":{"operationId":"invoices_GET_InvoiceApplicationParts","summary":"List all application parts of an invoice","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement)\nenabled. The Invoice Settlement feature is generally available as of Zuora Billing\nRelease 296 (March 2021). This feature includes Unapplied Payments, Credit and\nDebit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement,\nsee [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide)\nfor more information.\n\nIf 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.\n\nRetrieves information about the payments or credit memos that are applied to a\nspecified invoice.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceApplicationPartCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/emails":{"post":{"operationId":"invoices_POST_EmailInvoice","summary":"Email an invoice","description":"Sends a posted invoice to the specified email addresses manually.\n### Notes\n - You must activate the **Manual Email For Invoice | Manual Email For Invoice** notification before emailing invoices. To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.\n\n - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Invoice Posted Default Email Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.\n\n - The invoices are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:\n * The `useEmailTemplateSetting` field is set to `false`.\n * The email addresses are not specified in the `emailAddresses` field.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostInvoiceEmailRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/files":{"get":{"operationId":"invoices_GET_InvoiceFiles","summary":"List all files of an invoice","description":"Retrieves the information about all PDF files of a specified invoice. \n\nInvoice PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\nYou can use the [Query](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'\"`.\nSee [Query an Invoice Body](https://knowledgecenter.zuora.com/Central_Platform/API/G_SOAP_API/E1_SOAP_API_Object_Reference/Invoice/Query_an_Invoice_Body_Field) for more information.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETInvoiceFilesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"invoices_POST_UploadFileForInvoice","summary":"Upload a file for an invoice","description":"Uploads an externally generated invoice PDF file for an invoice that is in Draft or Posted status.\nTo 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.\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one invoice.\n- Ensure that each uploaded PDF file has a unique name. Duplicate filenames are not allowed when attaching files to an invoice.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTUploadFileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The PDF file to upload for the invoice.\n"}}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/items":{"get":{"operationId":"invoices_GET_InvoiceItems","summary":"List all items of an invoice","description":"Retrieves the information about all items of a specified invoice. \n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETInvoiceItemsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/items/{itemId}/taxation-items":{"get":{"operationId":"invoices_GET_TaxationItemsOfInvoiceItem","summary":"List all taxation items of an invoice item","description":"Retrieves information about the taxation items of a specific invoice item. \n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique ID or number of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"itemId","in":"path","description":"The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETInvoiceTaxationItemsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/reverse":{"put":{"operationId":"invoices_PUT_ReverseInvoice","summary":"Reverse an invoice","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nReverses a posted invoice. The reversal operation is performed asynchronously when the invoice contains more than 2,000 items in total. \n\n If the specified invoice was created through invoice splitting, reversing that invoice also reverses all split invoices that were generated from the same original invoice. The original parent invoice remains in `Split` status and is not reversed. \n\n**Restrictions**\n\nYou are not allowed to reverse an invoice if any of the following restrictions is met:\n* Payments and credit memos are applied to the invoice.\n* The invoice is split.\n* The invoice is not in Posted status.\n* The total amount of the invoice is less than 0 (a negative invoice).\n* Using Tax Connector for Extension Platform to calculate taxes.\n* An invoice contains more than 50,000 items in total, including invoice items, discount items, and taxation items.\n\nSee [Invoice Reversal](https://knowledgecenter.zuora.com/CB_Billing/IA_Invoices/Reverse_Posted_Invoices) for more information.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutReverseInvoiceResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutReverseInvoiceType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/split":{"put":{"operationId":"invoices_splitInvoice","summary":"Split an invoice","description":"Splits a draft invoice into 2 to 20 invoices based on specified amounts or percentages. The source invoice must be in Draft status. For amount-based splits, the sum of all split amounts must exactly equal the original invoice total, and each split amount must be at least the minimum currency unit. For percentage-based splits, the sum of all split percentages must be exactly 100, up to 9 decimal places. Zuora distributes charges, discounts, tax amounts, and tax-exempt amounts proportionally across split invoices and uses a Largest Remainder algorithm to ensure precise rounding at both the line and invoice levels.\n\nIn exclusive-tax mode, split amounts can be specified excluding tax, with tax calculated at posting, or including tax when draft tax is calculated. In inclusive-tax mode, split amounts always represent tax-inclusive invoice totals, with embedded tax distributed proportionally.\n\nFor invoices with a large number of invoice items, this operation might be processed asynchronously. Use the `jobStatus` field in the response to determine the job status:\n- If `jobStatus` is `Completed`, the operation has finished and the response contains the result.\n- If `jobStatus` is `Pending`, the operation is still in progress, and you must retrieve the job status later to confirm completion.","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SplitInvoiceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SplitInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/taxation-items":{"post":{"operationId":"invoices_POST_INV_TaxationItems","summary":"Create taxation items for an invoice","description":"Creates taxation items for an invoice.\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique ID or number of an invoice. For example, 8a8082e65b27f6c3015ba45ff82c7172 or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemListType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTTaxationItemList"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/write-off-async":{"post":{"operationId":"invoices_writeOffInvoiceAsync","summary":"Write off an invoice asynchronously","description":"Asynchronously writes off a posted invoice.\\n\\nBy writing\\ \\ off an invoice, a credit memo is created and applied to the invoice. If the\\ \\ invoice contains more than 2,000 items, this operation is performed asynchronously.\\ \\ Use the [Retrieve invoice write-off async job](https://developer.zuora.com/v1-api-reference/api/invoices/retrieveinvoicewriteoffasyncjob) \\ operation to track the status of the async job.\\n\\n**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.\\n\n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteOffInvoiceAsyncJobResponse"}}}},"400":{"description":"Invalid input","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteOffInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/write-off-async-jobs/{asyncJobId}":{"get":{"operationId":"invoices_retrieveInvoiceWriteOffAsyncJob","summary":"Retrieve an invoice write-off async job","description":"Retrieves information about a specific asynchronous\\ \\ invoice write-off job.\\n\\n**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.\\n\n","tags":["invoices"],"parameters":[{"name":"asyncJobId","in":"path","description":"The unique ID of the invoice write-off async job. For example, 8a92ade496140e830196141f6cfa0001.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteOffInvoiceAsyncJobResponse"}}}},"400":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/write-off":{"put":{"operationId":"invoices_PUT_WriteOffInvoice","summary":"Write off an invoice","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWrites off a posted invoice. \n\nBy writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero.\n\nIf you set the **Create credit memos mirroring invoice items billing rule** to **Yes**, you can write off an invoice even if all its items have zero balance.\n\n**Restrictions**: You cannot write off an invoice if any of the following restrictions is met:\n* The balance of an invoice has been changed before Invoice Settlement is enabled.\n For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice.\n* An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items.\nSee [Invoice Write-off](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/IA_Invoices/Invoice_Write-Off) for more information. \n","tags":["invoices"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTWriteOffInvoiceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTWriteOffInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos":{"get":{"operationId":"creditMemos_GET_CreditMemos","summary":"List credit memos","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all credit memos. \n\nFor a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).\n\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n \nExamples:\n\n- /v1/credit-memos?status=Posted\n\n- /v1/credit-memos?referredInvoiceId=null&status=Draft\n\n- /v1/credit-memos?status=Posted&type=External&sort=+number\n","tags":["creditMemos"],"parameters":[{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"accountId","in":"query","description":"This parameter filters the response based on the `accountId` field.\n","required":false,"schema":{"type":"string"}},{"name":"accountNumber","in":"query","description":"This parameter filters the response based on the `accountNumber` field.\n","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"This parameter filters the response based on the `amount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"appliedAmount","in":"query","description":"This parameter filters the response based on the `appliedAmount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"autoApplyUponPosting","in":"query","description":"This parameter filters the response based on the `autoApplyUponPosting` field. \n","required":false,"schema":{"type":"boolean"}},{"name":"createdById","in":"query","description":"This parameter filters the response based on the `createdById` field. \n","required":false,"schema":{"type":"string"}},{"name":"createdDate","in":"query","description":"This parameter filters the response based on the `createdDate` field. \n","required":false,"schema":{"type":"string"}},{"name":"creditMemoDate","in":"query","description":"This parameter filters the response based on the `creditMemoDate` field. \n","required":false,"schema":{"type":"string","format":"date"}},{"name":"currency","in":"query","description":"This parameter filters the response based on the `currency` field. \n","required":false,"schema":{"type":"string"}},{"name":"excludeFromAutoApplyRules","in":"query","description":"This parameter filters the response based on the `excludeFromAutoApplyRules` field. \n","required":false,"schema":{"type":"boolean"}},{"name":"number","in":"query","description":"This parameter filters the response based on the `number` field. \n","required":false,"schema":{"type":"string"}},{"name":"referredInvoiceId","in":"query","description":"This parameter filters the response based on the `referredInvoiceId` field. \n","required":false,"schema":{"type":"string"}},{"name":"refundAmount","in":"query","description":"This parameter filters the response based on the `refundAmount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"sourceId","in":"query","description":"This parameter filters the response based on the `sourceId` field. \n","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"This parameter filters the response based on the `status` field. \n","required":false,"schema":{"$ref":"#/components/schemas/V1CreditMemosGetParametersStatus"}},{"name":"targetDate","in":"query","description":"This parameter filters the response based on the `targetDate` field. \n","required":false,"schema":{"type":"string","format":"date"}},{"name":"taxAmount","in":"query","description":"This parameter filters the response based on the `taxAmount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"totalTaxExemptAmount","in":"query","description":"This parameter filters the response based on the `totalTaxExemptAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"transferredToAccounting","in":"query","description":"This parameter filters the response based on the `transferredToAccounting` field. \n","required":false,"schema":{"$ref":"#/components/schemas/V1CreditMemosGetParametersTransferredToAccounting"}},{"name":"unappliedAmount","in":"query","description":"This parameter filters the response based on the `unappliedAmount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"updatedById","in":"query","description":"This parameter filters the response based on the `updatedById` field. \n","required":false,"schema":{"type":"string"}},{"name":"updatedDate","in":"query","description":"This parameter filters the response based on the `updatedDate` field.\n","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by credit memo number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - accountId\n - amount\n - appliedAmount\n - createdById\n - createdDate\n - creditMemoDate\n - number\n - referredInvoiceId\n - refundAmount\n - status\n - targetDate\n - taxAmount\n - totalTaxExemptAmount\n - transferredToAccounting\n - unappliedAmount\n - updatedDate\n\n\n \nExamples:\n\n- /v1/credit-memos?sort=+number\n\n- /v1/credit-memos?status=Processed&sort=-number,+amount\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"creditMemos_POST_CreditMemoFromPrpc","summary":"Create a credit memo from a charge","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates an ad-hoc credit memo from a product rate plan charge. Zuora supports the creation of credit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models. \n\nWhen credit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.\n\nYou can create a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["creditMemos"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemoFromChargeRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/bulk":{"post":{"operationId":"creditMemos_POST_CreateCreditMemos","summary":"Create credit memos","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request. \n\n- If you set the `sourceType` request field to `Invoice`, you can create multiple credit memos from invoices.\n- If you set the `sourceType` request field to `Standalone`, you can create multiple credit memos from product rate plan charges.\n\nThe credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully. \n\nYou can create credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nZero-amount memo items are supported in the following scenarios:\n- If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.\n- If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.\n","tags":["creditMemos"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreditMemosResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBulkCreditMemosRequestType"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"creditMemos_PUT_UpdateCreditMemos","summary":"Update credit memos","description":"**Notes:** \n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n- You can update credit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nUpdates the basic and finance information about multiple credit memos. You can update a maximum of 50 credit memos in one single request. \n\nCurrently, 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:\n- The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n- The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nThe Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items.\n\nThe credit memos that are updated are each in separate database transactions. If the update of one credit memo fails, other credit memos can still be updated successfully.\n","tags":["creditMemos"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreditMemosResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTBulkCreditMemosRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/pdf-status":{"get":{"operationId":"creditMemos_Get_CreditMemoPdfStatus","summary":"Retrieve the PDF file generation status of credit memos","description":"Retrieves the PDF generation statuses of a batch of credit memos.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKeys","in":"query","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. ","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCreditMemoPdfStatusBatchResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoId}/items/{cmitemid}/taxation-items":{"get":{"operationId":"creditMemos_GET_TaxationItemsOfCreditMemoItem","summary":"List all taxation items of a credit memo item","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves information about the taxation items of a specific credit memo item. \n","tags":["creditMemos"],"parameters":[{"name":"cmitemid","in":"path","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).\n","required":true,"schema":{"type":"string"}},{"name":"creditMemoId","in":"path","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemsOfCreditMemoItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoId}/write-off":{"put":{"operationId":"creditMemos_PUT_WriteOffCreditMemo","summary":"Write off a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nWrite off a fully unapplied credit memo. When writing off a credit memo, a debit memo is automatically created, and then the credit memo to be written off is fully applied to the debit memo.\n\nNote that this operation only supports writing off credit memos that are fully unapplied. Credit memos that are not fully unapplied cannot be written off by this operation. \n","tags":["creditMemos"],"parameters":[{"name":"creditMemoId","in":"path","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTCreditMemoWriteOffResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTCreditMemoWriteOff"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}":{"get":{"operationId":"creditMemos_GET_CreditMemo","summary":"Retrieve a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about a specific credit memo.\n\nFor a use case of this operation, see [Get credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Get-credit-memo).\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"creditMemos_PUT_UpdateCreditMemo","summary":"Update a credit memo","description":"**Notes:** \n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n- 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.\n\nUpdates the basic and finance information about a credit memo. \n\nCurrently, 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:\n- The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n- The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nThe [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.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTCreditMemoType"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"creditMemos_DELETE_CreditMemo","summary":"Delete a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nDeletes a credit memo. Only credit memos with the Cancelled status can be deleted. \n\nYou can delete a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/apply":{"put":{"operationId":"creditMemos_PUT_ApplyCreditMemo","summary":"Apply a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nApplies a posted credit memo to one or more invoices and debit memos. \n\nYou can apply a credit memo to an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nWhen you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000.\n\nIf the limit is hit, you can follow the following instructions:\n\n- If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000.\n- If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000.\n \nIf the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: \n\n(number of invoice items + number of debit memo items) * number of credit memo items\n\nOtherwise, the First In First Out rule will be used instead of the Proration rule.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyCreditMemoType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/cancel":{"put":{"operationId":"creditMemos_PUT_CancelCreditMemo","summary":"Cancel a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCancels a credit memo. Only credit memos with the Draft status can be cancelled. \n\nYou can cancel a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/emails":{"post":{"operationId":"creditMemos_POST_EmailCreditMemo","summary":"Email a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nSends a posted credit memo to the specified email addresses manually.\n\n\n\n### Notes\n - You must activate the **Email Credit Memo | Manually email Credit Memo** notification before emailing credit memos. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.\n\n\n - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Credit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.\n\n\n - The credit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:\n\n * The `useEmailTemplateSetting` field is set to `false`.\n * The email addresses are not specified in the `emailAddresses` field.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The ID or number of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostCreditMemoEmailRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/files":{"get":{"operationId":"creditMemos_GET_CreditMemoFiles","summary":"List all files of a credit memo","description":"Retrieves the information about all PDF files of a specified credit memo. \n\nCredit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of an credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoFilesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"creditMemos_POST_UploadFileForCreditMemo","summary":"Upload a file for a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUploads an externally generated PDF file for a credit memo that is in Draft or Posted status.\n\nTo use this operation, you must enable the Modify Modify Credit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one credit memo.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The ID or number of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTUploadFileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The PDF file to upload for the credit memo.\n"}}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/items":{"get":{"operationId":"creditMemos_GET_CreditMemoItems","summary":"List credit memo items","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all items of a credit memo. A credit memo item is a single line item in a credit memo. \n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n \n - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100\n \n - /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n \n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"amount","in":"query","description":"This parameter filters the response based on the `amount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"appliedAmount","in":"query","description":"This parameter filters the response based on the `appliedAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"createdById","in":"query","description":"This parameter filters the response based on the `createdById` field. \n","required":false,"schema":{"type":"string"}},{"name":"createdDate","in":"query","description":"This parameter filters the response based on the `createdDate` field. \n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id","in":"query","description":"This parameter filters the response based on the `id` field. \n","required":false,"schema":{"type":"string"}},{"name":"refundAmount","in":"query","description":"This parameter filters the response based on the `refundAmount` field. \n","required":false,"schema":{"type":"number","format":"double"}},{"name":"serviceEndDate","in":"query","description":"This parameter filters the response based on the `serviceEndDate` field. \n","required":false,"schema":{"type":"string","format":"date"}},{"name":"serviceStartDate","in":"query","description":"This parameter filters the response based on the `serviceStartDate` field. \n","required":false,"schema":{"type":"string","format":"date"}},{"name":"sku","in":"query","description":"This parameter filters the response based on the `sku` field. \n","required":false,"schema":{"type":"string"}},{"name":"skuName","in":"query","description":"This parameter filters the response based on the `skuName` field. \n","required":false,"schema":{"type":"string"}},{"name":"sourceItemId","in":"query","description":"This parameter filters the response based on the `sourceItemId` field. \n","required":false,"schema":{"type":"string"}},{"name":"subscriptionId","in":"query","description":"This parameter filters the response based on the `subscriptionId` field.\n","required":false,"schema":{"type":"string"}},{"name":"updatedById","in":"query","description":"This parameter filters the response based on the `updatedById` field. \n","required":false,"schema":{"type":"string"}},{"name":"updatedDate","in":"query","description":"This parameter filters the response based on the `updatedDate` field.\n","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sort","in":"query","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by updated date.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - amount\n - appliedAmount\n - createdById\n - createdDate\n - id\n - refundAmount\n - serviceEndDate\n - serviceStartDate\n - sku\n - skuName\n - sourceItemId\n - subscriptionId\n - updatedById\n - updatedDate\n\n \nExamples:\n\n- /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?sort=createdDate\n\n- /v1/credit-memos/402890245c7ca371015c7cb40ac30015/items?amount=100&sort=createdDate\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoItemsListType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/items/{cmitemid}":{"get":{"operationId":"creditMemos_GET_CreditMemoItem","summary":"Retrieve a credit memo item","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves the information about a specific item of a credit memo. A credit memo item is a single line item in a credit memo.\n","tags":["creditMemos"],"parameters":[{"name":"cmitemid","in":"path","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).\n","required":true,"schema":{"type":"string"}},{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/parts":{"get":{"operationId":"creditMemos_GET_CreditMemoParts","summary":"List all parts of a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all parts of a credit memo. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos. You can use this operation to get all the applied and unapplied portions of a credit memo. Note that a fully refunded credit memo does not contain any credit memo part.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoPartsCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/parts/{partid}":{"get":{"operationId":"creditMemos_GET_CreditMemoPart","summary":"Retrieve a credit memo part","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about a specific credit memo part. A credit memo can consist of an unapplied part, and several parts applied to invoices and debit memos.\n\nA fully refunded credit memo does not contain any credit memo part.\n","tags":["creditMemos"],"parameters":[{"name":"partid","in":"path","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).\n","required":true,"schema":{"type":"string"}},{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoPartType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/pdfs":{"post":{"operationId":"creditMemos_POST_CreditMemoPDF","summary":"Generate a credit memo PDF file","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates a PDF file for a specified credit memo. To access the generated PDF file, you can download it by clicking **View PDF** on the detailed credit memo page through the Zuora UI.\n\nThis REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTMemoPdfResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/post":{"put":{"operationId":"creditMemos_PUT_PostCreditMemo","summary":"Post a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nPosts a credit memo to activate it. You can post credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/refund":{"post":{"operationId":"creditMemos_POST_RefundCreditMemo","summary":"Refund a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRefunds a full or partial posted credit memo to your customers. Only the amount of unapplied part could be refunded. \n\nYou can refund a credit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nWhen you refund a credit memo, the total number of credit memo items to be refunded must be less than or equal to 15,000.\n\nFor a use case of this operation, see [Refund processing](https://developer.zuora.com/rest-api/general-concepts/authentication//#Refund-processing).\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETRefundCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostNonRefRefundType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/reverse":{"put":{"operationId":"creditMemos_PUT_ReverseCreditMemo","summary":"Reverse a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nReverses 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.\n\nYou 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.\n\n**Restrictions**\n\nYou cannot reverse credit memos if any of the following conditions is met:\n\n* A credit memo's applied amount is not 0.\n* A credit memo is not in Posted status.\n* A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutReverseCreditMemoResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutReverseCreditMemoType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/taxation-items":{"post":{"operationId":"creditMemos_POST_CM_TaxationItems","summary":"Create taxation items for a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates taxation items for a credit memo.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemListType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTTaxationItemListForCMType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/unapply":{"put":{"operationId":"creditMemos_PUT_UnapplyCreditMemo","summary":"Unapply a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nUnapplies an applied credit memo from one or more invoices and debit memos. The full applied amount from invoices and debit memos is transferred into the unapplied amount of the credit memo. \n\nYou can unapply a credit memo from an invoice or a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nWhen you unapply a credit memo, the total number of credit memo items and the items that credit memo items to be unapplied from must be less than or equal to 15,000.\n\nIf the limit is hit, you can follow the following instructions:\n\n- If you want to unapply one credit memo without specifying invoices or debit memos and the limit is hit, you have to specify the invoice items or debit memo items in the request to decrease the number of items.\n- If you want to unapply one credit memo from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request.\n- If you want to unapply one credit memo from a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000.\n- If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000.\n- 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.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnapplyCreditMemoType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/unpost":{"put":{"operationId":"creditMemos_PUT_UnpostCreditMemo","summary":"Unpost a credit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUnposts a credit memo that is in Posted status. If a credit memo has been applied or refunded, you are not allowed to unpost it. After a credit memo is unposted, its status becomes Draft. \n\nYou can unpost credit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). \n\nYou 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.' \n\n 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).","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172 or CM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/invoice/{invoiceKey}":{"post":{"operationId":"creditMemos_POST_CreditMemoFromInvoice","summary":"Create a credit memo from an invoice","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates an ad-hoc credit memo from an invoice.\n\nYou can create a credit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nFor a use case of this operation, see [Create credit memo](https://developer.zuora.com/rest-api/general-concepts/authentication//#Create-credit-memo).\n\nZero-amount memo items are supported in the following scenarios:\n- If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.\n- If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.\n","tags":["creditMemos"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of an invoice that you want to create a credit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETCreditMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemoFromInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/unapply-async-jobs/{unapplyAsyncJobId}":{"get":{"operationId":"creditMemos_getUnapplyCreditMemoAsyncJob","summary":"Retrieve an async unapply credit memo job by ID","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n Retrieves information about a specific Async Credit Memo Unapply job. ","tags":["creditMemos"],"parameters":[{"name":"unapplyAsyncJobId","in":"path","description":"The unique ID of a Credit Memo Async Unapply Job Id. For example, 8a92ade496140e830196148cd0af000a.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/apply-async-jobs/{applyAsyncJobId}":{"get":{"operationId":"creditMemos_getApplyCreditMemoAsyncJob","summary":"Retrieve an async unapply credit memo job by ID","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n Retrieves information about a specific Async Credit Memo Apply job. ","tags":["creditMemos"],"parameters":[{"name":"applyAsyncJobId","in":"path","description":"The unique ID of a Credit Memo Async Apply Job Id. For example, 8a92ade496140e830196141f6cfa0001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/apply-async":{"put":{"operationId":"creditMemos_applyCreditMemoAsync","summary":"Apply a credit memo aysnchronously","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\n Asynchronously applies a posted credit memo to one or more invoices\n 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.\n 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.\n The maximum number of invoices that you can specify in the request is 1,000\n If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 10,000: \n\n(number of invoice items) * number of credit memo items\n\nOtherwise, the First In First Out rule will be used instead of the Proration rule.\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncApplyCreditMemoRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/unapply-async":{"put":{"operationId":"creditMemos_unapplyCreditMemoAsync","summary":"Unapply a credit memo asynchronously","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n 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. \n\nYou 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)\n 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.\n The maximum number of invoices that you can specify in the request is 1,000\n","tags":["creditMemos"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceSettlementAsyncJobResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncUnapplyCreditMemoRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos":{"get":{"operationId":"debitMemos_GET_DebitMemos","summary":"List debit memos","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves the information about all debit memos associated with all customer accounts.\n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/debit-memos?status=Posted\n\n- /v1/debit-memos?referredInvoiceId=null&status=Draft\n\n- /v1/debit-memos?status=Posted&type=External&sort=+number\n","tags":["debitMemos"],"parameters":[{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"accountId","in":"query","description":"This parameter filters the response based on the `accountId` field.\n","required":false,"schema":{"type":"string"}},{"name":"accountNumber","in":"query","description":"This parameter filters the response based on the `accountNumber` field.\n","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"This parameter filters the response based on the `amount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"balance","in":"query","description":"This parameter filters the response based on the `balance` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"beAppliedAmount","in":"query","description":"This parameter filters the response based on the `beAppliedAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"createdById","in":"query","description":"This parameter filters the response based on the `createdById` field.\n","required":false,"schema":{"type":"string"}},{"name":"createdDate","in":"query","description":"This parameter filters the response based on the `createdDate` field.\n","required":false,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"This parameter filters the response based on the `currency` field.\n","required":false,"schema":{"type":"string"}},{"name":"debitMemoDate","in":"query","description":"This parameter filters the response based on the `debitMemoDate` field.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"dueDate","in":"query","description":"This parameter filters the response based on the `dueDate` field.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"number","in":"query","description":"This parameter filters the response based on the `number` field.\n","required":false,"schema":{"type":"string"}},{"name":"referredInvoiceId","in":"query","description":"This parameter filters the response based on the `referredInvoiceId` field.\n","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"This parameter filters the response based on the `status` field.\n","required":false,"schema":{"$ref":"#/components/schemas/V1DebitMemosGetParametersStatus"}},{"name":"targetDate","in":"query","description":"This parameter filters the response based on the `targetDate` field.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"taxAmount","in":"query","description":"This parameter filters the response based on the `taxAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"totalTaxExemptAmount","in":"query","description":"This parameter filters the response based on the `totalTaxExemptAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"updatedById","in":"query","description":"This parameter filters the response based on the `updatedById` field.\n","required":false,"schema":{"type":"string"}},{"name":"updatedDate","in":"query","description":"This parameter filters the response based on the `updatedDate` field.\n","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by debit memo number.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - number\n - accountId\n - debitMemoDate\n - targetDate\n - dueDate\n - amount\n - taxAmount\n - totalTaxExemptAmount\n - balance\n - beAppliedAmount\n - referredInvoiceId\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n\n \nExamples:\n\n- /v1/debit-memos?sort=+number\n\n- /v1/debit-memos?status=Processed&sort=-number,+amount\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"debitMemos_POST_DebitMemoFromPrpc","summary":"Create a debit memo from a charge","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates an ad-hoc debit memo from a product rate plan charge. Zuora supports the creation of debit memos from any type of product rate plan charge. The charges can also have any amount and any charge model, except for discout charge models.\n\nWhen debit memos are created from product rate plan charges, the specified amount with decimal places is now validated based on the decimal places supported by each currency.\n\nYou can create a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["debitMemos"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemoFromChargeRequest"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"debitMemos_PUT_UpdateDebitMemosDueDates","summary":"Update due dates for debit memos","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nUpdates the due date for multiple debit memos in one single request. \n\nThis API operation will be deprecated. You can use the [Update debit memos](https://developer.zuora.com/api-references/api/operation/PUT_BulkUpdateDebitMemos) instead, which provides more flexible functionality.\n","tags":["debitMemos"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTBatchDebitMemosRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/bulk":{"post":{"operationId":"debitMemos_POST_CreateDebitMemos","summary":"Create debit memos","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates multiple debit memos from invoices or product rate plan charges. You can create a maximum of 50 debit memos in one single request. \n\n- If you set the `sourceType` request field to `Invoice`, you can create multiple debit memos from invoices.\n- If you set the `sourceType` request field to `Standalone`, you can create multiple debit memos from product rate plan charges.\n\nThe debit memos that are created are each in separate database transactions. If the creation of one debit memo fails, other debit memos can still be created successfully.\n\nYou can create debit memos only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["debitMemos"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDebitMemosResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBulkDebitMemosRequestType"}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"debitMemos_PUT_UpdateDebitMemos","summary":"Update debit memos","description":"**Notes:** \n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n- 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.\n\nUpdates the basic and finance information about multiple debit memos. You can update a maximum of 50 credit memos in one single request. \n\nCurrently, 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:\n- The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n- The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nThe [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.\n\nThe credit memos that are updated are each in separate database transactions. If the update of one debit memo fails, other debit memos can still be updated successfully.\n","tags":["debitMemos"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDebitMemosResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTBulkDebitMemosRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/pdf-status":{"get":{"operationId":"debitMemos_Get_DebitMemoPdfStatus","summary":"Retrieve the PDF file generation status of debit memos","description":"Retrieves the PDF generation statuses of a batch of debit memos.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKeys","in":"query","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. ","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDebitMemoPdfStatusBatchResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoId}/application-parts":{"get":{"operationId":"debitMemos_GET_DebitMemoApplicationParts","summary":"List all application parts of a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves information about the payments or credit memos that are applied to a specified debit memo. \n\nIf 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.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoId","in":"path","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDebitMemoApplicationPartCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoId}/items/{dmitemid}/taxation-items":{"get":{"operationId":"debitMemos_GET_TaxationItemsOfDebitMemoItem","summary":"List all taxation items of a debit memo item","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves information about the taxation items of a specific debit memo item.\n","tags":["debitMemos"],"parameters":[{"name":"dmitemid","in":"path","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems).\n","required":true,"schema":{"type":"string"}},{"name":"debitMemoId","in":"path","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemsOfDebitMemoItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}":{"get":{"operationId":"debitMemos_GET_DebitMemo","summary":"Retrieve a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about a specific debit memo.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"debitMemos_PUT_DebitMemo","summary":"Update a debit memo","description":"**Notes:** \n- This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n- 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.\n\nUpdates the basic and finance information about a debit memo. \n\n\nCurrently, 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:\n- The memo is created from a product rate plan charge and you use Avalara to calculate the tax.\n- The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.\n\nThe [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.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTDebitMemoType"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"debitMemos_DELETE_DebitMemo","summary":"Delete a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nDeletes a debit memo. Only debit memos with the Cancelled status can be deleted. \n\nYou can delete a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items.","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/cancel":{"put":{"operationId":"debitMemos_PUT_CancelDebitMemo","summary":"Cancel a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCancels a debit memo. Only debit memos with the Draft status can be cancelled. \n\nYou can cancel a debit memo only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000003.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/collect":{"post":{"operationId":"debitMemos_POST_DebitMemoCollect","summary":"Collect a posted debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nThis API operation provides an easy way to let the client-side to collect an existing posted debit memo.\nIt supports the following steps:\n 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.\n 2. Apply unapplied payments to the posted debit memo by Oldest-First-Largest-First rule if there are more than one unapplied payments.\n 3. Process payment to the posted debit memo if there is an open-balance on it.\n\n**Restrictions**\n\nSince 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:\n 1. If the target debit memo gets more than 10 debit memo items, the request will be rejected.\n 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.\n 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.\n 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.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemoCollectResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemoCollectRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/emails":{"post":{"operationId":"debitMemos_POST_EmailDebitMemo","summary":"Email a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nSends a posted debit memo to the specified email addresses manually.\n\n\n\n### Notes\n - You must activate the **Email Debit Memo | Manually email Debit Memo** notification before emailing debit memos. To include the debit memo PDF in the email, select the **Include Debit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.\n\n\n - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the **Manual Email for Debit Memo Default Template** template is used. See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.\n\n\n - The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:\n\n * The `useEmailTemplateSetting` field is set to `false`.\n * The email addresses are not specified in the `emailAddresses` field.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostDebitMemoEmailType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/files":{"get":{"operationId":"debitMemos_GET_DebitMemoFiles","summary":"List all files of a debit memo","description":"Retrieves the information about all PDF files of a specified debit memo. \n\nDebit Memo PDF files are returned in reverse chronological order by the value of the `versionNumber` field.\n**Note**: This API only retrieves the PDF files that have been generated. If the latest PDF file is being generated, it will not be included in the response.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of an debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoFilesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"debitMemos_POST_UploadFileForDebitMemo","summary":"Upload a file for a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUploads an externally generated PDF file for a debit memo that is in Draft or Posted status.\n\nTo use this operation, you must enable the Modify Debit Memo permission. See [Billing Permissions](https://knowledgecenter.zuora.com/Billing/Tenant_Management/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n\nThis operation has the following restrictions:\n- Only the PDF file format is supported.\n- The maximum size of the PDF file to upload is 4 MB.\n- A maximum of 50 PDF files can be uploaded for one debit memo.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The ID or number of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTUploadFileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The PDF file to upload for the debit memo.\n"}}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/items":{"get":{"operationId":"debitMemos_GET_DebitMemoItems","summary":"List debit memo items","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nRetrieves the information about all items of a debit memo. A debit memo item is a single line item in a debit memo. \n\n### Filtering\n\nYou can use query parameters to restrict the data returned in the response. Each query parameter corresponds to one field in the response body.\n\nIf the value of a filterable field is string, you can set the corresponding query parameter to `null` when filtering. Then, you can get the response data with this field value being `null`. \n\nExamples:\n\n- /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100\n\n- /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"amount","in":"query","description":"This parameter filters the response based on the `amount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"beAppliedAmount","in":"query","description":"This parameter filters the response based on the `beAppliedAmount` field.\n","required":false,"schema":{"type":"number","format":"double"}},{"name":"createdById","in":"query","description":"This parameter filters the response based on the `createdById` field.\n","required":false,"schema":{"type":"string"}},{"name":"createdDate","in":"query","description":"This parameter filters the response based on the `createdDate` field.\n","required":false,"schema":{"type":"string"}},{"name":"id","in":"query","description":"This parameter filters the response based on the `id` field.\n","required":false,"schema":{"type":"string"}},{"name":"serviceEndDate","in":"query","description":"This parameter filters the response based on the `serviceEndDate` field.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"serviceStartDate","in":"query","description":"This parameter filters the response based on the `serviceStartDate` field.\n","required":false,"schema":{"type":"string","format":"date"}},{"name":"sku","in":"query","description":"This parameter filters the response based on the `sku` field.\n","required":false,"schema":{"type":"string"}},{"name":"skuName","in":"query","description":"This parameter filters the response based on the `skuName` field.\n","required":false,"schema":{"type":"string"}},{"name":"sourceItemId","in":"query","description":"This parameter filters the response based on the `sourceItemId` field.\n","required":false,"schema":{"type":"string"}},{"name":"subscriptionId","in":"query","description":"This parameter filters the response based on the `subscriptionId` field.\n","required":false,"schema":{"type":"string"}},{"name":"updatedById","in":"query","description":"This parameter filters the response based on the `updatedById` field.\n","required":false,"schema":{"type":"string"}},{"name":"updatedDate","in":"query","description":"This parameter filters the response based on the `updatedDate` field.\n","required":false,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort on.\n\nA sortable field uses the following form: \n\n*operator* *field_name*\n\nYou can use at most two sortable fields in one URL path. Use a comma to separate sortable fields. For example: *operator* *field_name*, *operator* *field_name* \n\n*operator* is used to mark the order of sequencing. The operator is optional. If you only specify the sortable field without any operator, the response data is sorted in descending order by this field.\n\n - The `-` operator indicates an ascending order.\n - The `+` operator indicates a descending order.\n\nBy default, the response data is displayed in descending order by updated date.\n\n*field_name* indicates the name of a sortable field. The supported sortable fields of this operation are as below:\n\n - id\n - amount\n - beAppliedAmount\n - sku\n - skuName\n - serviceStartDate\n - serviceEndDate\n - sourceItemId\n - createdDate\n - createdById\n - updatedDate\n - updatedById\n - subscriptionId\n\n \nExamples:\n\n- /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?sort=createdDate\n\n- /v1/debit-memos/402890245c7ca371015c7cb40b28001f/items?amount=100&sort=createdDate\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoItemCollectionType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/items/{dmitemid}":{"get":{"operationId":"debitMemos_GET_DebitMemoItem","summary":"Retrieve a debit memo item","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nRetrieves information about a specific item of a debit memo. A debit memo item is a single line item in a debit memo.\n","tags":["debitMemos"],"parameters":[{"name":"dmitemid","in":"path","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo items](https://developer.zuora.com/api-references/api/operation/GET_DebitMemoItems).\n","required":true,"schema":{"type":"string"}},{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/pdfs":{"post":{"operationId":"debitMemos_POST_DebitMemoPDF","summary":"Generate a debit memo PDF file","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates 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.\n\nThis REST API operation can be used only if you have the billing document file generation feature and the Billing user permission \"Regenerate PDF\" enabled.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTMemoPdfResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/post":{"put":{"operationId":"debitMemos_PUT_PostDebitMemo","summary":"Post a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nPosts a debit memo to activate it. You can post debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions).\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/taxation-items":{"post":{"operationId":"debitMemos_POST_DM_TaxationItems","summary":"Create taxation items for a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nCreates taxation items for a debit memo.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemListType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTTaxationItemListForDMType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/unpost":{"put":{"operationId":"debitMemos_PUT_UnpostDebitMemo","summary":"Unpost a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nUnposts a debit memo that is in Posted status. If any credit memo or payment has been applied to a debit memo, you are not allowed to unpost the debit memo. After a debit memo is unposted, its status becomes Draft.\n\nYou can unpost debit memos only if you have the [Billing permissions](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles#Billing_Permissions). \n\nYou 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.' \n\n 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).","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/invoice/{invoiceKey}":{"post":{"operationId":"debitMemos_POST_DebitMemoFromInvoice","summary":"Create a debit memo from an invoice","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nCreates an ad-hoc debit memo from an invoice.\n\nYou can create a debit memo from an invoice only if you have the user permission. See [Billing Roles](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/A_Administrator_Settings/User_Roles/d_Billing_Roles) for more information.\n","tags":["debitMemos"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of an invoice that you want to create a debit memo from. For example, 2c93808457d787030157e030d10f3f64 or INV00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETDebitMemoType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemoFromInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/write-off":{"put":{"operationId":"debitMemos_PUT_WriteOffDebitMemo","summary":"Write off a debit memo","description":"**Note:** This operation is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information.\n\nWrites off a debit memo. \n\nBy 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.\n\n**Note**: \n* 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.\n* The total amount must be equal to the amount entered at the invoice item level.\n* If the non revenue impact value is set to Yes, then the non revenue write off accounting code must be specified.\n","tags":["debitMemos"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTWriteOffDebitMemoResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTWriteOffDebitMemoRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/service-providers":{"get":{"operationId":"eInvoicing_GET_EInvoicingServiceProviders","summary":"List e-invoicing service providers","description":"Lists information about e-invoicing service providers.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEInvoicingServiceProvidersResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"eInvoicing_POST_EInvoicingServiceProvider","summary":"Create an e-invoicing service provider","description":"Creates an e-invoicing service provider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingServiceProviderResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEInvoicingServiceProviderRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/service-providers/{key}":{"get":{"operationId":"eInvoicing_GET_EInvoicingServiceProvider","summary":"Retrieve an e-invoicing service provider","description":"Retrieves information about an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique ID or number of the e-invoicing service provider that you want to retrieve information about.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingServiceProviderResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"eInvoicing_PUT_UpdateEInvoicingServiceProvider","summary":"Update an e-invoicing service provider","description":"Updates information about an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique ID or number of the e-invoicing service provider that you want to update.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingServiceProviderResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEInvoicingServiceProviderRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"eInvoicing_DELETE_EInvoicingServiceProvider","summary":"Delete an e-invoicing service provider","description":"Deletes an e-invoicing service privider.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique ID or number of the e-invoicing service provider that you want to \n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/business-regions":{"get":{"operationId":"eInvoicing_GET_EInvoicingBusinessRegions","summary":"List e-invoicing business regions","description":"Lists information about e-invoicing business regions.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEInvoicingBusinessRegionsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"eInvoicing_POST_CreateEInvoicingBusinessRegion","summary":"Create an e-invoicing business region","description":"Creates an e-invoicing business region.\n\nYou 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.\n\nThe 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.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingBusinessRegionResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEInvoicingBusinessRegionRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/business-regions/{key}":{"get":{"operationId":"eInvoicing_GET_EInvoicingBusinessRegion","summary":"Retrieve an e-invoicing business region","description":"Retrieves information about an e-invoicing business region.\n\nYou 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.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unqiue ID or number of the e-invoicing business region that you want to retrieve information about.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingBusinessRegionResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"eInvoicing_PUT_UpdateEInvoicingBusinessRegion","summary":"Update an e-invoicing business region","description":"Updates an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled. \n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unqiue ID or number of the e-invoicing business region that you want to update.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoicingBusinessRegionResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEInvoicingBusinessRegionRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"eInvoicing_DELETE_EInvoicingBusinessRegion","summary":"Delete an e-invoicing business region","description":"Deletes an e-invoicing business region by key. The key can be the unique ID or number of an e-invoicing business region.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unqiue ID or number of the e-invoicing business region that you want to delete.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/e-invoice/mandates":{"get":{"operationId":"eInvoicing_getEinvoiceMandates","summary":"List mandates for downloading files","description":"Fetches mandates for downloading files based on the country code, category, and process type selection. \nThis API operation returns the the list of file formats in which the document can be downloaded.\n\n**Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"countryCode","in":"query","description":"2-digit country code.\n","required":false,"schema":{"type":"string"}},{"name":"processType","in":"query","description":"The process type of the e-invoicing business region.\n- If the service provider is Sovos, the process type is `Clearance` or `ClearanceWithCancellation`.\n- If the service provider is Avalara, the process type is `Clearance` or `PEPPOLNetwork`.\n- If the service provider is PEPPOL, the process type is `Unknown`.\n","required":false,"schema":{"$ref":"#/components/schemas/V1EInvoiceMandatesGetParametersProcessType"}},{"name":"provider","in":"query","description":"The service provider that is associated with the country and process type.","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EinvoiceFetchMandates"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/e-invoice/mandate":{"get":{"operationId":"eInvoicing_getEinvoiceMandateOnInvoice","summary":"Retrieve a mandate for downloading a file","description":"Fetches mandates for downloading e-invoice based on the country code, category, and process type selection. \n\n**Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique number or ID of the invoice.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EinvoiceInvoiceFetchMandate"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/e-invoice/mandate":{"get":{"operationId":"eInvoicing_getEinvoiceCreditMemoMandate","summary":"Retrieve a mandate for downloading a credit memo","description":"Fetches mandates for downloading a Credit Memo file based on the country code, category, and process type selection. \n\n**Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique number or ID of the Credit Memo.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemosEinvoiceMandate"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/e-invoice/mandate":{"get":{"operationId":"eInvoicing_getEinvoiceDebitMemoMandate","summary":"Retrieve a mandate for downloading a debit memo","description":"Fetches mandates for downloading a Debit Memo file based on the country code, category, and process type selection. \n\n**Note**: This operation is available only if you have the E-Invoicing feature for Avalara in **Early Availabiltiy** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique number or ID of the Debit Memo.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemosEinvoiceMandate"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/e-invoice/download":{"get":{"operationId":"eInvoicing_downloadEinvoiceOfSpecifiedFormat","summary":"Download a file in the specified file format","description":"Downloads the e-invoice based on the selected file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. \n","tags":["eInvoicing"],"parameters":[{"name":"invoiceKey","in":"path","description":"The unique number or ID of the e-invoice.\n","required":true,"schema":{"type":"string"}},{"name":"fileFormat","in":"query","description":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. \nWhen 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.\n \nFollowing mapping will be used for user representation of file formats:\n\n - XML: `application/xml`\n - PDF: `application/pdf` \n - ZIP: `application/zip` \n - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` \n","required":false,"schema":{"$ref":"#/components/schemas/V1InvoicesInvoiceKeyEInvoiceDownloadGetParametersFileFormat"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EinvoiceDownload"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/e-invoice/download":{"get":{"operationId":"eInvoicing_downloadCreditMemoEinvoice","summary":"Download a credit memo in the specified file format","description":"Downloads the credit memo based on the specified file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. \n","tags":["eInvoicing"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The unique number or ID of Credit Memo.\n","required":true,"schema":{"type":"string"}},{"name":"fileFormat","in":"query","description":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. \nWhen 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.\n\nFollowing mapping will be used for user representation of file formats:\n\n - XML: `application/xml`\n - PDF: `application/pdf` \n - ZIP: `application/zip` \n - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` \n","required":false,"schema":{"$ref":"#/components/schemas/V1CreditMemosCreditMemoKeyEInvoiceDownloadGetParametersFileFormat"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemosEinvoiceDownload"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/e-invoice/download":{"get":{"operationId":"eInvoicing_downloadDebitMemoEinvoice","summary":"Download a debit memo in the specified file format","description":"Downloads the debit memo based on the specified file format. \nThe system supports XML, UBL, PNG, or QR codes formats that each country requires or supports. \n","tags":["eInvoicing"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The unique number or ID of Debit Memo.","required":true,"schema":{"type":"string"}},{"name":"fileFormat","in":"query","description":"This parameter is exclusively accessible for documents submitted via the Avalara E-Invoice integration. \nWhen 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.\n\nFollowing mapping will be used for user representation of file formats:\n\n - XML: `application/xml`\n - PDF: `application/pdf` \n - ZIP: `application/zip` \n - OASIS_Universal_Business_Language_XML: `application/vnd.oasis.ubl+xml` \n","required":false,"schema":{"$ref":"#/components/schemas/V1DebitMemosDebitMemoKeyEInvoiceDownloadGetParametersFileFormat"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebitMemosEinvoiceDownload"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/e-invoice/cancel":{"put":{"operationId":"eInvoicing_cancelEInvoiceByInvoiceKey","summary":"Cancel the e-invoice file for an invoice","description":"Cancels the E-Invoice for the given billing document","tags":["eInvoicing"],"parameters":[{"name":"invoiceKey","in":"path","description":"Invoice Id or Number","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PutCancelEInvoiceRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/templates":{"get":{"operationId":"eInvoicing_GET_EInvoiceFileTemplates","summary":"List e-invoice file templates","description":"Lists information about e-invoice file templates.\n\nYou 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:\n`/v1/einvoice/templates?country=IN&documentType=Invoice&provider=Sovos`\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"country","in":"query","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.\n","required":true,"schema":{"type":"string"}},{"name":"documentType","in":"query","description":"The type of billing documents for which the e-invoice file template is intended.\n","required":true,"schema":{"$ref":"#/components/schemas/V1EinvoiceTemplatesGetParametersDocumentType"}},{"name":"provider","in":"query","description":"The name of the e-invoicing service provider that assists in generating e-invoice files. \n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEInvoiceFileTemplatesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"eInvoicing_POST_CreateEInvoiceFileTemplate","summary":"Create an e-invoice file template","description":"Creates an e-invoice file templates for your billing documents, including invoices, credit memos, and debit memos. \n\nZuora 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.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoiceFileTemplateResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEInvoiceFileTemplateRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/einvoice/templates/{key}":{"get":{"operationId":"eInvoicing_GET_EInvoiceFileTemplate","summary":"Retrieve an e-invoice file template","description":"Retrieves information about an e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique number or ID of the e-invoice file template that you want to retrieve information about.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoiceFileTemplateResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"eInvoicing_PUT_EInvoiceFileTemplate","summary":"Update an e-invoice file template","description":"Updates information about an e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique number or ID of the e-invoice file template that you want to update.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEInvoiceFileTemplateResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEInvoiceFileTemplateRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"eInvoicing_DELETE_EInvoiceFileTemplate","summary":"Delete an e-invoice file template","description":"Deletes an e-invoice file template by key. The key can be the unique ID or number of an e-invoice file template.\n\n**Note**: This operation is available only if you have the E-Invoicing feature in **Early Adopter** phase enabled.\n","tags":["eInvoicing"],"parameters":[{"name":"key","in":"path","description":"The unique ID or number of the e-invoice file template that you want to delete.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/e-invoice/sync-status":{"put":{"operationId":"eInvoicing_updateInvoiceInvokeSyncStatus","summary":"Sync the e-Invoice status of an invoice","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.\n\n**Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or `Failed`. If the status is different, the request will be rejected.\n","tags":["eInvoicing"],"parameters":[{"name":"invoiceKey","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"shouldIncludeAcknowledged","in":"query","description":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider\nwhen resyncing the e-invoice status.\n\n- If `false` (default), Zuora refreshes only the latest notifications that have not yet been\n acknowledged.\n- If `true`, Zuora performs a full re-sync and reprocesses all notifications from the beginning,\n which is useful if incremental requests return incomplete results (for example, after\n recreating notifications in Sovos).\n\n**Note:** This parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this\nparameter and apply the provider’s default resync behavior.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"transactionId","in":"query","description":"The **Provider Document ID** of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status.\n\n**Note:** This parameter is supported for both Sovos and Avalara.\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvoiceInvokeSyncStatusRequestClientRequestError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/e-invoice/sync-status":{"put":{"operationId":"eInvoicing_updateDebitMemoInvokeSyncStatus","summary":"Sync the e-Invoice status of a debit memo","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.\n\n**Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or `Failed`. If the status is different, the request will be rejected.\n","tags":["eInvoicing"],"parameters":[{"name":"debitMemoKey","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"shouldIncludeAcknowledged","in":"query","description":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider\nwhen resyncing the e-invoice status.\n\n- If `false` (default), Zuora refreshes only the latest notifications that have not yet been\n acknowledged.\n- If `true`, Zuora performs a full re-sync and reprocesses all notifications from the beginning,\n which is useful if incremental requests return incomplete results (for example, after\n recreating notifications in Sovos).\n\n**Note:** This parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this\nparameter and apply the provider’s default resync behavior.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"transactionId","in":"query","description":"The **Provider Document ID** of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status. \n\n**Note:** This parameter is supported for both Sovos and Avalara.\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDebitMemoInvokeSyncStatusRequestClientRequestError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/e-invoice/sync-status":{"put":{"operationId":"eInvoicing_updateCreditMemoInvokeSyncStatus","summary":"Sync the e-Invoice status of a credit memo","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.\n\n**Note**: This API can only be invoked when the current e-Invoice status is one of: `Processing`, `ApprovedByAuthority`, `RetrieveTimeout`, or `Failed`. If the status is different, the request will be rejected.\n","tags":["eInvoicing"],"parameters":[{"name":"creditMemoKey","in":"path","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.","required":true,"schema":{"type":"string"}},{"name":"shouldIncludeAcknowledged","in":"query","description":"Controls how Zuora pulls e-invoice notifications from the e-invoicing service provider\nwhen resyncing the e-invoice status.\n\n- If `false` (default), Zuora refreshes only the latest notifications that have not yet been\n acknowledged.\n- If `true`, Zuora performs a full re-sync and reprocesses all notifications from the beginning,\n which is useful if incremental requests return incomplete results (for example, after\n recreating notifications in Sovos).\n\n**Note:** This parameter is primarily applicable to Sovos. For other providers, Zuora may ignore this\nparameter and apply the provider’s default resync behavior.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"transactionId","in":"query","description":"The **Provider Document ID** of the billing document in the e-invoicing service provider. If specified, Zuora uses this value when resyncing the e-invoice status. \n\n**Note:** This parameter is supported for both Sovos and Avalara.\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCreditMemoInvokeSyncStatusRequestClientRequestError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoices/{invoiceKey}/einvoice/generate":{"put":{"operationId":"eInvoicing_PUT_GenerationEInvoiceGenerationForInvoices","summary":"Generate an e-invoice file for an invoice","description":"Generates an e-invoice file for an invoice. \nIf 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**.\n\n**Note**:\n\n- E-invoicing with Sovos and E-invoicing with PEPPOL Extract are generally available. \n- E-invoicing with Avalara is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. \n\nThe **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. \n","tags":["eInvoicing"],"parameters":[{"name":"invoiceKey","in":"path","description":"The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/credit-memos/{creditMemoKey}/e-invoice/generate":{"put":{"operationId":"eInvoicing_PUT_GenerateEInvoiceFileForCreditMemo","summary":"Generate an e-invoice file for a credit memo","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**.\n\n**Note**:\n\n- E-invoicing with Sovos and E-invoicing with PEPPOL Extract are generally available. \n- E-invoicing with Avalara is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. \n\nThe **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. \n","tags":["eInvoicing"],"parameters":[{"name":"creditMemoKey","in":"path","description":"The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/debit-memos/{debitMemoKey}/e-invoice/generate":{"put":{"operationId":"eInvoicing_PUT_GenerateEInvoiceFileForDebitMemo","summary":"Generate an e-invoice file for a debit memo","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**.\n\n**Note**: \n\n- E-invoicing with Sovos and E-invoicing with PEPPOL Extract are generally available. \n- E-invoicing with Avalara is in the **Early Availability** phase. We are actively soliciting feedback from a small set of early availability users before releasing this feature as generally available. If you want to join this early availability program, submit a request at Zuora Global Support. \n\nThe **Regenerate E-Invoice** action is available in the **Generated** status for the PEPPOL service provider. ","tags":["eInvoicing"],"parameters":[{"name":"debitMemoKey","in":"path","description":"The ID or number of the debit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or DM-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules":{"post":{"operationId":"invoiceSchedules_POST_CreateInvoiceSchedule","summary":"Create an invoice schedule","description":"Creates an invoice schedule.\n\n### Limitations\n\nThis API operation has the following limitations:\n\n* You can create at most 50 invoice schedule items in one request.\n\n* You can associate at most 10 orders with an invoice schedule in one request.\n\n* You can associate at most 300 subscriptions with an invoice schedule in one\nrequest, including those contained in orders and separate subscriptions.\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceScheduleResponses"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreateInvoiceScheduleRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}":{"get":{"operationId":"invoiceSchedules_GET_InvoiceSchedule","summary":"Retrieve an invoice schedule","description":"Retrieves detailed information about an invoice schedule.\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the invoice schedule to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","maximum":40,"default":20}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceScheduleResponses"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"invoiceSchedules_PUT_UpdateInvoiceSchedule","summary":"Update an invoice schedule","description":"Updates a pending invoice schedule. You can use this API operation to update invoice schedules in the following aspects:\n - Update notes and pending invoice schedule items\n - Update orders associated with invoice schedules\n - Remove or add invoice schedule items\nFor more samples, see Edit invoice schedules\n\n### Restrictions and limitations\nWhen updating invoice schedules through the REST API, keep the following restrictions and limitations in mind:\n - You can only update invoice schedule items in `Pending` status.\n - You can only add orders or specific subscriptions to pending invoice schedules, and remove orders or specific subscriptions from pending invoice schedules.\n - For the invoice schedule items that you want to update, you must include the new values for these items in the request.\n - 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.\n - 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.\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the invoice schedule to be updated. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceScheduleResponses"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTUpdateInvoiceScheduleRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"invoiceSchedules_DELETE_InvoiceSchedule","summary":"Delete an invoice schedule","description":"Deletes an invoice schedule in Pending status. The status of the invoice\nschedule to be deleted must be `Pending`.\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the invoice schedule to be deleted. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}/execute":{"post":{"operationId":"invoiceSchedules_POST_ExecuteInvoiceSchedule","summary":"Execute an invoice schedule","description":"Executes an invoice schedule immediately. During the execution, a bill run is created and generates an invoice or a credit memo asynchronously. \n\nWhen you use this API operation to execute an invoice schedule item, you have the flexibility to decide whether to specify a specific item ID.\n- If you specify the unique ID of an invoice schedule item to be executed in the request, the corresponding invoice schedule item is executed.\n- 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. \n\nA 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:\n- Use the Generate billing documents by account ID API operation\n- Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API\n\nFor more samples, see [Execute invoice schedules](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Billing_Schedule/Billing_Schedule_tutorials/Execute_invoice_schedules).\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the schedule to be executed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteInvoiceScheduleBillRunResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTExecuteInvoiceScheduleRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}/pause":{"put":{"operationId":"invoiceSchedules_PUT_PauseInvoiceSchedule","summary":"Pause an invoice schedule","description":"Pauses an invoice schedule immediately.\n\nA paused invoice schedule and charges inside cannot be automatically executed by Zuora\nScheduler or by the Execute an invoice schedule\nAPI operation. In this case, you can do one of the following:\n- Use the Generate billing documents by account ID API operation\n- Create a bill run with the target date greater than the next run date of the invoice schedule through UI or API\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the schedule to be paused. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceScheduleResponses"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}/resume":{"put":{"operationId":"invoiceSchedules_PUT_ResumeInvoiceSchedule","summary":"Resume an invoice schedule","description":"Resumes an invoice schedule in Paused status immediately.\n\nAfter an invoice schedule is resumed, it can continue to be automatically executed\nby Zuora Scheduler or by the [Execute an invoice schedule](https://developer.zuora.com/api-references/api/operation/POST_ExecuteInvoiceSchedule/)\nAPI operation.\n\n**Note**: This operation is available only if you have the Billing Schedule feature enabled.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the schedule to be resumed. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceScheduleResponses"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}/detach":{"put":{"operationId":"invoiceSchedules_detachChargesFromInvoiceSchedule","summary":"Detach charges from an invoice schedule","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.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the invoice schedule to detach charges from. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachInvoiceScheduleRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/invoice-schedules/{scheduleKey}/attach":{"put":{"operationId":"invoiceSchedules_attachChargesToInvoiceSchedule","summary":"Attach charges to an invoice schedule","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. \nYou 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.\n","tags":["invoiceSchedules"],"parameters":[{"name":"scheduleKey","in":"path","description":"The unique ID or number of the invoice schedule to attach charges to. For example, 2c92c8955bd63cc1015bd7c151af02ab or IS-0000001.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachInvoiceScheduleRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/object/taxation-item":{"post":{"operationId":"taxationItems_Object_POSTTaxationItem","summary":"CRUD: Create a taxation item","description":"Creates a Taxation Item object.","tags":["taxationItems"],"parameters":[{"name":"rejectUnknownFields","in":"query","description":"Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateOrModifyResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyBadRequestResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyCreateTaxationItem"}}}},"security":[{"bearerAuth":[]}]}},"/v1/taxation-items/{id}":{"get":{"operationId":"taxationItems_GET_TaxationItem","summary":"Retrieve a taxation item\n","description":"Retrieves the information about a specific taxation item by ID.\n","tags":["taxationItems"],"parameters":[{"name":"id","in":"path","description":"The unique ID of a taxation item.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"taxationItems_PUT_TaxationItem","summary":"Update a taxation item","description":"Updates a specific taxation item by ID.\n","tags":["taxationItems"],"parameters":[{"name":"id","in":"path","description":"The unique ID of a taxation item.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETTaxationItemType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTTaxationItemType"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"taxationItems_DELETE_TaxationItem","summary":"Delete a taxation item","description":"Deletes a specific taxation item by ID.\n","tags":["taxationItems"],"parameters":[{"name":"id","in":"path","description":"The unique ID of a taxation item.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/sequence-sets":{"get":{"operationId":"sequenceSets_GET_SequenceSets","summary":"List sequence sets","description":"Retrieves information about all sequence sets configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou can use query parameters to restrict the data returned in the response.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n","tags":["sequenceSets"],"parameters":[{"name":"pageSize","in":"query","description":"The number of records returned per page in the response.\n","required":false,"schema":{"type":"integer","default":20}},{"name":"page","in":"query","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.\n","required":false,"schema":{"type":"integer","minimum":1,"default":1}},{"name":"name","in":"query","description":"The name or number of a specific sequence set.\n","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSequenceSetsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"sequenceSets_POST_SequenceSets","summary":"Create sequence sets","description":"Creates sequence sets, allowing distinct numbering sequences for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\nYou 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.\n\nSee [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.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n","tags":["sequenceSets"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTSequenceSetsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTSequenceSetsRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/sequence-sets/{id}":{"get":{"operationId":"sequenceSets_GET_SequenceSet","summary":"Retrieve a sequence set","description":"Retrieves information about a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n","tags":["sequenceSets"],"parameters":[{"name":"id","in":"path","description":"The ID or number of the sequence set to retrieve information about.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETSequenceSetResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"sequenceSets_PUT_SequenceSet","summary":"Update a sequence set","description":"Updates a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n","tags":["sequenceSets"],"parameters":[{"name":"id","in":"path","description":"The ID or number of the sequence set to update.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTSequenceSetResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTSequenceSetRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"sequenceSets_DELETE_SequenceSet","summary":"Delete a sequence set","description":"Deletes a specific sequence set configured for billing documents, payments, and refunds. Billing documents include invoices, credit memos, and debit memos.\n\n**Note**: The Credit and Debit Memos feature is only available if you have [Invoice Settlement](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement) enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n","tags":["sequenceSets"],"parameters":[{"name":"id","in":"path","description":"The ID or number of the sequence set to delete.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/operations/billing-preview":{"post":{"operationId":"operations_POST_BillingPreview","summary":"Generate a billing preview","description":"\nGenerates 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.\n\nAdditionally, you can use the BillingPreview service to access real-time data on an individual customer's usage consumption. \n\nThe 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.\n\nIf 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. \n","tags":["operations"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingPreviewResult"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBillingPreviewParam"}}}},"security":[{"bearerAuth":[]}]}},"/v1/operations/invoice-collect":{"post":{"operationId":"operations_POST_TransactionInvoicePayment","summary":"Invoice and collect","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.\n\nYou can use this operation to generate invoices and collect payments on the posted invoices,\n or else simply collect payment on a specified existing\ninvoice. The customer's default payment method is used, and the full\namount due is collected. The operation depends on the parameters you\nspecify.\n\n- To generate one or more new invoices for that customer and collect\npayment on the generated and other unpaid invoice(s), leave the **invoiceId** field empty. \n\n- To collect payment on an existing invoice, specify the invoice ID. \n\n\nThe operation is atomic; if any part is unsuccessful, the entire\noperation is rolled back.\n\nWhen 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.\n\n- Orbital: `05 Do Not Honor`; `14 Invalid Credit Card Number`\n- Vantiv: `301 Invalid Account Number`; `304 Lost/Stolen Card` \n- CyberSource2: `202 Expired card`; `231 Invalid account number`\n\nFor more reason code information, see the corresponding payment gateway documentation. \n\n\n### Notes\n\nTimeouts may occur when using this method on an account that\nhas an extremely high number of subscriptions.\n","tags":["operations"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTInvoiceCollectResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTInvoiceCollectType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/operations/jobs/{jobId}":{"get":{"operationId":"operations_GET_OperationJob","summary":"Retrieve an operation job","description":"Retrieves information about a specific operation job.\n\nCurrently, you can only use this API operation to retrieve the status information about invoice deletion and reversal operation jobs.\n","tags":["operations"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the operation job to retrieve information about. For example, 2c92c8955bd63cc1015bd7c151af02ab.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOperationJobResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/operations/bulk-pdf":{"post":{"operationId":"operations_Create_BulkPDFToZIPGeneration","summary":"Export bulk PDF files","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.\n**Note**: Do not include multiple objectIds with the same PDF file names in a single bulk PDF upload request.\n","tags":["operations"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBulkPdfGenerationJobResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTBulkPdfGenerationJobRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/operations/bulk-pdf/{jobId}":{"get":{"operationId":"operations_Get_BulkPDFToZIPGeneration","summary":"Retrieve information of a bulk PDF file generation job","description":"Retrieves information about the job which includes its status, message, and downloadable ZIP file URL link.","tags":["operations"],"parameters":[{"name":"jobId","in":"path","description":"The ID of the job for which information needs to be retrieved. For example, 2c92c8955bd63cc1015bd7c151af02ab","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETBulkpdfGenerationJobResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/summary-statement-runs":{"post":{"operationId":"summaryStatements_createSummaryStatementRun","summary":"Create a summary statement run","description":"Allows you to initiate the generation of a summary statement run.\nYou can specify parameters such as the run type (AdHoc or scheduled) and the target account categories (single or multiple accounts).\n","tags":["summaryStatements"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryStatementRunResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SummaryStatementRunRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/summary-statements/{summaryStatementKey}":{"delete":{"operationId":"summaryStatements_deleteSummaryStatement","summary":"Delete a summary statement","description":"Deletes a specific summary statement.\n\nYou can delete a summary statement only when both the summary statement and its\nparent summary statement run are in terminal states.\n\nAllowed summary statement statuses:\n - `Completed`\n - `Canceled`\n - `Error`\n - `Previewing` (for temporary preview statements)\n\nAllowed parent summary statement run statuses:\n - `Completed`\n - `Error`\n - `Terminated`\n\nError scenarios:\n - Returns `400 INVALID_VALUE` if the summary statement status is `Pending` or `Processing`\n - Returns `400 INVALID_VALUE` if the parent summary statement run status is `Pending` or `Processing`\n - Returns `404 NOT_FOUND` if the summary statement does not exist\n","tags":["summaryStatements"],"parameters":[{"name":"summaryStatementKey","in":"path","description":"The ID or number of the summary statement to delete.\nFor example, `2c92c8955bd63cc1015bd7c151af02ab` or `SS-00000001`.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling [Create an OAuth token](https://developer.zuora.com/api-references/api/operation/createToken).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/bill-runs":{"post":{"operationId":"billRun_POST_CreateBillRun","summary":"Create a bill run","description":"Creates an ad-hoc bill run or a scheduled bill run. Support the following:\n - Create ad-hoc or scheduled bill runs by batch\n - Create ad-hoc or scheduled bill runs by account\n - Create a bill run by subscription\n - Create ad-hoc or scheduled bill runs by custom filter combining the Account, Subscription, and Rate Plan objects.\n \n To use this operation, you must have the Create Bill Runs billing permission.\n\n**Notes**\n\nWhen using this operation to create bill runs, keep the following notes in mind:\n - 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.\n - When creating bill runs by account, only one single account is allowed. All subscription under the account are picked up.\n - When creating a bill run by subscription, all subscriptions must belong to the same account. At most 50 subscriptions are allowed. \n - 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. \n - When you use the `in` operator in an Account, Subscription, or Charge filter in `billRunFilters`, you can specify a maximum of 500 values in the list. If any `in` condition contains more than 500 values, the request fails validation, an error is returned, and the Bill Run is not started. This limit applies only to the `in` operator in Advanced Filters and does not limit the total number of accounts, subscriptions, or charges that the Bill Run can process.","tags":["billRun"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBillRunResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreateBillRunRequestType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/bill-runs/{billRunId}":{"get":{"operationId":"billRun_GET_BillRun","summary":"Retrieve a bill run","description":"Retrieves the information about a specific bill run.\n","tags":["billRun"],"parameters":[{"name":"billRunId","in":"path","description":"The unique ID of a bill run.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBillRunResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"billRun_DELETE_DeleteBillRun","summary":"Delete a bill run","description":"Deletes a bill run. You can only delete bill runs in `Canceled` or `Error` status. \n","tags":["billRun"],"parameters":[{"name":"billRunId","in":"path","description":"The unique ID of a bill run.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBillRunResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/bill-runs/{billRunId}/cancel":{"put":{"operationId":"billRun_PUT_CancelBillRun","summary":"Cancel a bill run","description":"Cancels a bill run in Draft status.\n\nWhen cancelling a scheduled bill run, keep the following information in mind:\n- 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.\n- If you set `cancelOnce` to `false`, all future recurring bill runs are cancelled.\n","tags":["billRun"],"parameters":[{"name":"billRunId","in":"path","description":"The unique ID of a bill run.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelBillRunResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"cancelOnce":{"type":"boolean","default":true,"description":"Whether to cancel the current bill run or cancel all future recurring bill runs, only valid for a scheduled bill run.\n"}}}}}},"security":[{"bearerAuth":[]}]}},"/v1/bill-runs/{billRunId}/post":{"put":{"operationId":"billRun_PUT_PostBillRun","summary":"Post a bill run","description":"Posts a bill run asynchronously. To post a bill run, the current bill run must be in `Completed` status.\n\nWhen 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`.\n","tags":["billRun"],"parameters":[{"name":"billRunId","in":"path","description":"The unique ID of a bill run.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBillRunResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"invoiceDate":{"type":"string","format":"date","description":"The date that appears on the invoice being created, in `yyyy-mm-dd` format. \n\nThe value cannot fall in a closed accounting period.\n"}},"required":["invoiceDate"]}}}},"security":[{"bearerAuth":[]}]}},"/v1/bill-runs/{billRunKey}/emails":{"post":{"operationId":"billRun_POST_EmailBillingDocumentsfromBillRun","summary":"Email billing documents generated from a bill run","description":"Manually emails all the billing documents that are generated from a specified bill run to your customers. \n\n\nBill runs can generate invoices and credit memos based on your [invoice and credit memo generation rule](https://knowledgecenter.zuora.com/CB_Billing/Invoice_Settlement/Credit_and_Debit_Memos/Rules_for_Generating_Invoices_and_Credit_Memos). Credit memos are only available if you have the Invoice Settlement feature enabled.\n\n\nUsing this API operation, the billing documents are sent to the email addresses specified in the **To Email** field of the email templates. The email template used for each billing document is set in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. See [Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information about how to edit the **To Email** field in the email template.\n\n\n\n\n\n### Notes\n - Even though no field is required in the Request body, you still need to specify `{}` in the request. Otherwise, an error will be returned.\n\n\n - You can only email posted billing documents.\n\n\n - You must activate the following notifications before emailing invoices and credit memos:\n - **Manual Email For Invoice | Manual Email For Invoice** \n - **Email Credit Memo | Manually email Credit Memo**\n\n\n - To include the invoice PDF in the email, select the **Include Invoice PDF** check box in the **Edit notification** dialog from the Zuora UI. To include the credit memo PDF in the email, select the **Include Credit Memo PDF** check box in the **Edit notification** dialog from the Zuora UI. See [Create and Edit Notifications](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/C_Create_Notifications#section_2) for more information.\n\n\n\n - Zuora sends the email messages based on the email template you set. You can set the email template to use in the **Delivery Options** panel of the **Edit notification** dialog from the Zuora UI. By default, the following templates are used for billing documents:\n - Invoices: **Invoice Posted Default Email Template**\n - Credit memos: **Manual Email for Credit Memo Default Template** \n\n See [Create and Edit Email Templates](https://knowledgecenter.zuora.com/CF_Users_and_Administrators/Notifications/Create_Email_Templates) for more information.\n","tags":["billRun"],"parameters":[{"name":"billRunKey","in":"path","description":"The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTEmailBillingDocfromBillRunType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/billing-preview-runs":{"post":{"operationId":"billingPreviewRun_POST_BillingPreviewRun","summary":"Create a billing preview run","description":"Creates a billing preview run for single and multiple customer accounts.\n\nThe maximum supported preview duration is 20 years, calculated from the current date to the target date.\n\nYou 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.\n\n**Note:** The preview results for each billing preview run will be stored in the system for 180 days; after that they will be purged.\n","tags":["billingPreviewRun"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Billing_Preview_Run_POST_BillingPreviewRun_Response_200"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostBillingPreviewRunParam"}}}},"security":[{"bearerAuth":[]}]}},"/v1/billing-preview-runs/{billingPreviewRunId}":{"get":{"operationId":"billingPreviewRun_GET_BillingPreviewRun","summary":"Retrieve a billing preview run","description":"Retrieves a preview of future invoice items for multiple customer accounts through a billing preview run. If you have the Invoice Settlement feature enabled, you can also retrieve a preview of future credit memo items. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see [Invoice Settlement Enablement and Checklist Guide](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/Invoice_Settlement_Migration_Checklist_and_Guide) for more information. \n\nA billing preview run asynchronously generates a downloadable CSV file containing a preview of invoice item data and credit memo item data for a batch of customer accounts. Note that if you set `storageOption` to `Database`, no CSV file is generate; instead, you can have a record in the billing preview result. You can use data source to query Billing Preview Run Result. \n","tags":["billingPreviewRun"],"parameters":[{"name":"billingPreviewRunId","in":"path","description":"Id of the billing preview run.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBillingPreviewRunResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods":{"post":{"operationId":"paymentMethods_POST_PaymentMethods","summary":"Create a payment method","description":"You can use this operation to create either a payment method associated \nwith a specific customer account, or an orphan payment method that is not associated\nwith any customer account.\n\nTo view the applicable fields for each payment method type, select the payment method type from the `type` list.\nThe following types of the payment methods are supported:\n\n * `CreditCard` - Credit card payment method.\n\n * `CreditCardReferenceTransaction` - Credit Card Reference\n Transaction. See [Supported payment\n methods](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Supported_Payment_Methods)\n for payment gateways that support this type of payment method.\n\n * `ACH` - ACH payment method.\n\n * `SEPA` - Single Euro Payments Area.\n\n * `Betalingsservice` - Direct Debit DK.\n\n * `Autogiro` - Direct Debit SE.\n\n * `Bacs` - Direct Debit UK.\n\n * `Becs` - Direct Entry AU.\n\n * `Becsnz` - Direct Debit NZ.\n\n * `PAD` - Pre-Authorized Debit.\n\n * `PayPalCP` - PayPal Commerce Platform payment method. Use this type\n if you are using a [PayPal Commerce Platform\n Gateway](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Commerce_Platform_Gateway)\n instance.\n\n * `PayPalEC` - PayPal Express Checkout payment method. Use this type\n if you are using a [PayPal Payflow Pro\n 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)\n instance.\n\n * `PayPalNativeEC` - PayPal Native Express Checkout payment method.\n Use this type if you are using a [PayPal Express Checkout\n Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Express_Checkout_Gateway)\n instance.\n\n * `PayPalAdaptive` - PayPal Adaptive payment method. Use this type if\n you are using a [PayPal Adaptive Payment\n Gateway](https://knowledgecenter.zuora.com/CB_Billing/M_Payment_Gateways/Supported_Payment_Gateways/PayPal_Adaptive_Payments_Gateway)\n instance.\n\n * `AdyenApplePay` - Apple Pay on Adyen Integration v2.0. See [Set up\n Adyen Apple\n Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Apple_Pay_on_Web/Set_up_Adyen_Apple_Pay)\n for details.\n\n * `AdyenGooglePay` - Google Pay on Adyen Integration v2.0. See [Set up\n Adyen Google\n Pay](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Adyen_Google_Pay)\n for details.\n\n * `GooglePay` - Google Pay on Chase Paymentech Orbital gateway\n integration. See [Set up Google Pay on\n Chase](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/L_Payment_Methods/Payment_Method_Types/Set_up_Google_Pay_on_Chase)\n for details. \n\n * `AmazonPay` - Amazon Pay integration. \n\nThe fields marked as `required` must be specified when creating non-tokenized payment methods. \nFor more information about the required fields for the tokenization of payment methods, see Create tokenized payment methods with existing tokens or account information.\n","tags":["paymentMethods"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/decryption":{"post":{"operationId":"paymentMethods_POST_PaymentMethodsDecryption","summary":"Create an Apple Pay payment method","description":"The decryption API endpoint can conditionally perform 4 tasks in one atomic call:\n * Decrypt Apple Pay Payment token\n * Create Credit Card Payment Method in Zuora with decrypted Apple Pay information\n * Create a stored credential profile within the Apple Pay payment method\n * Process Payment on a specified Invoice (optional)\n","tags":["paymentMethods"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodResponseDecryption"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodDecryption"}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}":{"get":{"operationId":"paymentMethods_GET_PaymentMethod","summary":"Retrieve a payment method","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.\n\n**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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"Unique ID of the payment method to update.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPaymentMethodResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"put":{"operationId":"paymentMethods_PUT_PaymentMethod","summary":"Update a payment method","description":"This operation allows you to update an existing payment method.\n\nThe following fields in the request body can be updated for any payment method types:\n - `maxConsecutivePaymentFailures`\n - `paymentRetryWindow`\n - `useDefaultRetryRule`\n\n\nThe following fields in the request body can be updated for any payment method types \nexcept for Credit Card Reference Transaction payment methods:\n - `authGateway`\n - `accountHolderInfo`\n - `gatewayOptions`\n - `ipAddress`\n - Custom fields\n\nThe following fields in the request body can be updated only for Credit Card payment methods:\n - `expirationMonth`\n - `expirationYear`\n - `securityCode`\n\nThe following field in the request body can be updated for Credit Card, Credit Card Reference Transaction, ACH, and\nBank Transfer payment methods:\n - `mandateInfo`\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"Unique ID of the payment method to update.","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTPaymentMethodResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTPaymentMethodRequest"}}}},"security":[{"bearerAuth":[]}]},"delete":{"operationId":"paymentMethods_DELETE_PaymentMethods","summary":"Delete a payment method","description":"Deletes a credit card payment method.\n\nIf the specified payment method is the account's default payment\nmethod, the request will fail. In that case, you must first designate a\ndifferent payment method for that customer to be the default.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","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.)","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/verify":{"put":{"operationId":"paymentMethods_PUT_VerifyPaymentMethods","summary":"Verify a payment method","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.\n\nZuora 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.\n\nIf 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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"The ID of the payment method to be verified.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTVerifyPaymentMethodResponseType"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTVerifyPaymentMethodType"}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/scrub":{"put":{"operationId":"paymentMethods_PUT_ScrubPaymentMethods","summary":"Scrub a payment method","description":"\nThis 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. \n\nThis operation will scrub the sensitive data. \n\nIf 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.\n\n**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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"The ID of the payment method where you want to scrub the sensitive data.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/balance":{"get":{"operationId":"paymentMethods_getBankAccountBalance","summary":"Retrieve the balance of a bank account","description":"Zuora supports Plaid's Auth and Balance products for ACH transactions. \nAuth authenticates account details before sending requests to the gateway, \nwhile Balance checks the real-time account balance before transactions. \nUse this API operation to implement the integration with Plaid Balance manually.\n\nBefore you use this API operation, ensure that the support for Plaid Auth and Balance is enabled. \nFor more information, see Enable the support for Plaid account validation solution.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"The unique ID of the payment method, such as `40289f3291d2587b0191d280fa20012g`.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBankAccountBalanceResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/profiles":{"get":{"operationId":"paymentMethods_GET_StoredCredentialProfiles","summary":"List stored credential profiles of a payment method","description":"Retrieves the stored credential profiles within a payment method.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"ID of a payment method.\n","required":true,"schema":{"type":"string"}},{"name":"includeAll","in":"query","description":"Specifies whether to retrieve all the stored credential profiles within the payment method.\n\nBy 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.\n","required":false,"schema":{"type":"boolean","default":false}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStoredCredentialProfilesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"paymentMethods_POST_CreateStoredCredentialProfile","summary":"Create a stored credential profile","description":"Creates a stored credential profile within a payment method.\n\nThe 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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"ID of a payment method.\n","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifiedStoredCredentialProfileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStoredCredentialProfileRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel":{"post":{"operationId":"paymentMethods_POST_CancelStoredCredentialProfile","summary":"Cancel a stored credential profile","description":"Cancels a stored credential profile within a payment method.\n\nCancelling 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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"ID of a payment method.\n","required":true,"schema":{"type":"string"}},{"name":"profile-number","in":"path","description":"Number that identifies a stored credential profile within the payment method.\n","required":true,"schema":{"type":"integer"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifiedStoredCredentialProfileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire":{"post":{"operationId":"paymentMethods_POST_ExpireStoredCredentialProfile","summary":"Expire a stored credential profile","description":"Expires a stored credential profile within a payment method.\n\nExpiring 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.\n","tags":["paymentMethods"],"parameters":[{"name":"payment-method-id","in":"path","description":"ID of a payment method.\n","required":true,"schema":{"type":"string"}},{"name":"profile-number","in":"path","description":"Number that identifies a stored credential profile within the payment method.\n","required":true,"schema":{"type":"integer"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifiedStoredCredentialProfileResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/wallet/domains":{"get":{"operationId":"paymentMethods_getWalletDomains","summary":"List registered domains","description":"Use this operation to retreive list of registered domains.\n\nYou 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.\n","tags":["paymentMethods"],"parameters":[{"name":"domainName","in":"query","description":"Specifies a domain name such as `zuora.com` and the registered domains containing the specified domain name will be returned. \n\nFor 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.\n","required":false,"schema":{"type":"string"}},{"name":"walletType","in":"query","description":"The type of digital wallet for the domain registration. This field is required and determines which wallet-specific domain management flow is executed.","required":true,"schema":{"$ref":"#/components/schemas/V1PaymentMethodsWalletDomainsGetParametersWalletType"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETListApplePayDomainsResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]},"post":{"operationId":"paymentMethods_registerWalletDomain","summary":"Register a wallet domain","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. \n\nFor more information about Zuora's JavaScript SDK for Apple Pay integration, see Set up Apple Pay through the JavaScript SDK approach.\n","tags":["paymentMethods"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTRegisterApplePayDomainResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTRegisterApplePayDomainRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-methods/wallet/domains/{id}":{"delete":{"operationId":"paymentMethods_deleteUnregisterWalletDomain","summary":"Unregister a wallet domain","description":"Use this operation to unregister a wallet domain.\n","tags":["paymentMethods"],"parameters":[{"name":"id","in":"path","description":"The ID of the domain, such as `402881a38924ff1001892502da090021`.","required":true,"schema":{"type":"string"}},{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DELETEUnresigerApplePayDomainResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/web-payments/sessions":{"post":{"operationId":"paymentMethods_POST_CreatePaymentSession","summary":"Create a payment session","description":"Use this operation to create a payment session on your server side. \nThe response contains a token for the payment session data. \n\nIn addition to the required `accountId` and `currency` fields, you can specify the following fields \nto define the payment flow mode as one of the following:\n - Create and save a payment method:\n - `processPayment`: `false`\n - `storePaymentMethod`: `true`\n - `amount`\n - Process a one-time payment without saving the payment method:\n - `processPayment`: `true`\n - `storePaymentMethod`: `false`\n - `amount` or `invoices` + `amount`\n - Process the first payment and save the payment method for subsequent recurring payments:\n - `processPayment`: `true`\n - `storePaymentMethod`: `true`\n - `amount` or `invoices` + `amount`\n\nFor more information, see the following articles:\n - Payment Form Implementation Guide\n - Set up a payment method through JavaScript SDK integration\n - Set up Alipay payment methods with Zuora JavaScript SDK\n","tags":["paymentMethods"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreatePaymentSessionResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreatePaymentSessionRequest"}}}},"security":[{"bearerAuth":[]}]}},"/open-payment-method-types":{"post":{"operationId":"customPaymentMethodTypes_POST_CreateDraftOpenPaymentMethodType","summary":"Create a draft custom payment method type","description":"Creates a draft version of a custom payment method type. Revision number 1 is assigned to this version. You can update your draft version through the [Update a custom payment method type](https://developer.zuora.com/api-references/api/operation/PUT_UpdateOpenPaymentMethodType/) operation. You must publish your draft version through the [Publish a custom payment method type](https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/) operation before your custom payment method type goes live.\n","tags":["customPaymentMethodTypes"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreateOpenPaymentMethodTypeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTCreateOpenPaymentMethodTypeRequest"}}}},"security":[{"bearerAuth":[]}]}},"/open-payment-method-types/publish/{paymentMethodTypeName}":{"put":{"operationId":"customPaymentMethodTypes_PUT_PublishOpenPaymentMethodType","summary":"Publish a custom payment method type","description":"Publish the latest draft revision of a specific custom payment method type.\n","tags":["customPaymentMethodTypes"],"parameters":[{"name":"paymentMethodTypeName","in":"path","description":"The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTPublishOpenPaymentMethodTypeResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/open-payment-method-types/{paymentMethodTypeName}":{"put":{"operationId":"customPaymentMethodTypes_PUT_UpdateOpenPaymentMethodType","summary":"Update a custom payment method type","description":"Update the latest draft version of your custom payment method type. If the latest draft version has been published, the revision number is increased by 1 after the draft version is updated. You must publish your latest revision again through the [Publish a custom payment method type](https://developer.zuora.com/api-references/api/operation/PUT_PublishOpenPaymentMethodType/) operation before your updated custom payment method type goes live.\n\n**Note**: In the request body, provide all the fields that define this custom payment method type including fields to be updated and the unchanged fields.\n","tags":["customPaymentMethodTypes"],"parameters":[{"name":"paymentMethodTypeName","in":"path","description":"The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTUpdateOpenPaymentMethodTypeResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PUTUpdateOpenPaymentMethodTypeRequest"}}}},"security":[{"bearerAuth":[]}]}},"/open-payment-method-types/{paymentMethodTypeName}/draft/{revisionNumber}":{"get":{"operationId":"customPaymentMethodTypes_GET_OpenPaymentMethodTypeRevision","summary":"Retrieve a specific draft revision of a custom payment method type","description":"Retrieves a specific draft revision of a custom payment method type.\n","tags":["customPaymentMethodTypes"],"parameters":[{"name":"paymentMethodTypeName","in":"path","description":"The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n","required":true,"schema":{"type":"string"}},{"name":"revisionNumber","in":"path","description":"The revision number of the draft revision to be retrieved.\n","required":true,"schema":{"type":"integer"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/open-payment-method-types/{paymentMethodTypeName}/published":{"get":{"operationId":"customPaymentMethodTypes_GET_OpenPaymentMethodTypePublish","summary":"Retrieve a published custom payment method type","description":"Retrieves a published custom payment method type.\n","tags":["customPaymentMethodTypes"],"parameters":[{"name":"paymentMethodTypeName","in":"path","description":"The API name of the custom payment method type, such as `AmazonPay__c_12368`.\n","required":true,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETOpenPaymentMethodTypeRevisionResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-method-updaters":{"get":{"operationId":"paymentMethodUpdater_GET_PaymentMethodUpdaterInstances","summary":"List Payment Method Updater instances","description":"Retrieves the detailed information of all Payment Method Updater (PMU) instances on your tenant, except for American Express (AMEX).\n","tags":["paymentMethodUpdater"],"parameters":[{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GETPaymentMethodUpdaterInstancesResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/payment-method-updaters/batches":{"post":{"operationId":"paymentMethodUpdater_POST_PaymentMethodUpdaterBatch","summary":"Create a Payment Method Updater batch asynchronously","description":"Creates a Payment Method Updater (PMU) batch asynchronously. PMU for American Express (AMEX) is not supported.\n","tags":["paymentMethodUpdater"],"parameters":[{"name":"Idempotency-Key","in":"header","description":"Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. \n\nWith this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident. \n","required":false,"schema":{"type":"string","maxLength":255}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodUpdaterResponse"}}}},"400":{"description":"Request Errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommonResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTPaymentMethodUpdaterBatchRequest"}}}},"security":[{"bearerAuth":[]}]}},"/v1/object/payment-method-snapshot/{id}":{"get":{"operationId":"paymentMethodSnapshots_Object_GETPaymentMethodSnapshot","summary":"CRUD: Retrieve a payment method snapshot","description":"This REST API reference describes how to retrieve a Payment Method Snapshot.\n\nA Payment Method Snapshot is a copy of the particular Payment Method used in a transaction. If the Payment Method is deleted, the Payment Method Snapshot continues to retain the data used in each of the past transactions.\n\n### Notes\nThe following Payment Method fields are not available in Payment Method Snapshots:\n\n* `Active`\n* `AchAddress1`\n* `AchAddress2`\n* `CreatedById`\n* `CreatedDate`\n* `UpdatedById`\n* `UpdatedDate`\n\nThe Payment Method Snapshot field `PaymentMethodId` is not available in Payment Methods.\n","tags":["paymentMethodSnapshots"],"parameters":[{"name":"id","in":"path","description":"Object id","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Object fields to return","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyGetPaymentMethodSnapshot"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyNoDataResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/object/payment-method-transaction-log/{id}":{"get":{"operationId":"paymentMethodTransactionLogs_Object_GETPaymentMethodTransactionLog","summary":"CRUD: Retrieve a payment method transaction log","description":"Retrieves a Payment Method Transaction Log object.","tags":["paymentMethodTransactionLogs"],"parameters":[{"name":"id","in":"path","description":"Object id","required":true,"schema":{"type":"string"}},{"name":"fields","in":"query","description":"Object fields to return","required":false,"schema":{"type":"string"}},{"name":"Accept-Encoding","in":"header","description":"Include the `Accept-Encoding: gzip` header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response. \n\nIf specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a `Content-Encoding` header with the compression algorithm so that your client can decompress it.\n","required":false,"schema":{"type":"string"}},{"name":"Content-Encoding","in":"header","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.\n","required":false,"schema":{"type":"string"}},{"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 should not set this header.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Org-Ids","in":"header","description":"Comma separated IDs. If you have Zuora Multi-Org enabled, \nyou can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.\n\nThe IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails. 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.\n","required":false,"schema":{"type":"string"}},{"name":"Zuora-Track-Id","in":"header","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.\n\nThe 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 (`'`).\n","required":false,"schema":{"type":"string","maxLength":64}},{"name":"Zuora-Version","in":"header","description":"The minor API version.\n\nFor a list of available minor versions, see [API upgrades](https://developer.zuora.com/v1-api-reference/api-upgrades/).\n","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyGetPaymentMethodTransactionLog"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyUnauthorizedResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxyNoDataResponse"}}}}},"security":[{"bearerAuth":[]}]}},"/v1/hostedpages":{"get":{"operationId":"hostedPages_Get_HostedPages","summary":"List hosted pages","description":"Returns the Payment Pages configuration metadata,\nspecifically, page ID, page version, payment method type.\n\nThe following are the version-specific and general REST requests for Payment Pages:\n\n* The request for Payment Pages 2.0 configuration information: `GET*customField*__c. Custom field names are case\nsensitive. See [Manage Custom\nFields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields)\nfor more information.\n","title":"RemoveProductCustomFields"},"OrderActionRatePlanChargeRemoveCustomFields":{"type":"object","properties":{},"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 [Manage Custom Fields](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Manage_Custom_Fields) for more information.\n","title":"OrderActionRatePlanChargeRemoveCustomFields"},"OrderActionRatePlanChargeRemove":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"Read only. Identifies the charge to be updated.\n"},"productRatePlanChargeId":{"type":"string","description":"Identifier of the rate plan that was updated.\n"},"productRatePlanNumber":{"type":"string","description":"Number of a product rate plan for this subscription.\n"},"uniqueToken":{"type":"string","description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, you would assign a unique token to the product rate plan when added and use that token in future order actions.\n"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/OrderActionRatePlanChargeRemoveCustomFields"},"description":"Container for custom fields of a Rate Plan Charge object.\n"}},"description":"The JSON object containing the information for a charge update(custom fields only) in the\n'RemoveProduct' type order action.\nA custom field of rate plan charge can be updated from a subscription through one\norder action.\n- If you update customFields of a charge while removing a rate plan, specify the following fields:\n - `chargeNumber`\n - `productRatePlanChargeId`\n - `productRatePlanNumber`\n - `uniqueToken`\n - `customFields`\n","title":"OrderActionRatePlanChargeRemove"},"RemoveProduct":{"type":"object","properties":{"externalCatalogPlanId":{"type":"string","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.\n\n**Note:** If both `externalCatalogPlanId` and `ratePlanId` are provided. They must point to the same product rate plan. Otherwise, the request would fail.\n"},"productRatePlanNumber":{"type":"string","description":"Number of a product rate plan for this subscription.\n"},"ratePlanId":{"type":"string","description":"ID of the rate plan to remove. This can be the latest version or any history version of ID.\n"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a rate plan for this subscription.\n"},"uniqueToken":{"type":"string","description":"Unique identifier for the rate plan. This identifier enables you to refer to the rate plan before the rate plan has an internal identifier in Zuora."},"customFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RemoveProductCustomFields"},"description":"Container for custom fields of a Rate Plan object.\n"},"chargeUpdates":{"type":"array","items":{"$ref":"#/components/schemas/OrderActionRatePlanChargeRemove"}}},"description":"Information about an order action of type `RemoveProduct`.\n","title":"RemoveProduct"},"RenewSubscription":{"type":"object","properties":{"billToContactId":{"type":"string","description":"The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"},"clearingExistingBillToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingInvoiceGroupNumber":{"type":"boolean","default":false,"description":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingInvoiceTemplate":{"type":"boolean","default":false,"description":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingPaymentTerm":{"type":"boolean","default":false,"description":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingSequenceSet":{"type":"boolean","default":false,"description":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingShipToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.\n\n**Note:** \n To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support.\n"},"clearingExistingSoldToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"invoiceGroupNumber":{"type":["string","null"],"maxLength":255,"description":"The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"},"invoiceTemplateId":{"type":["string","null"],"description":"The ID of the invoice template associated with the subscription.\n\n**Note**: \n - 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. \n - 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.\n"},"paymentTerm":{"type":"string","description":"The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - 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. \n - 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..\n"},"sequenceSetId":{"type":["string","null"],"description":"The ID of the sequence set associated with the subscription.\n \n**Note**: \n - 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. \n - 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.\n"},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact associated with the subscription.\n\n**Note:**\n To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"}},"description":"Information about an order action of type `RenewSubscription`.\n","title":"RenewSubscription"},"CreateOrderResumeResumePeriodsType":{"type":"string","enum":["Day","Week","Month","Year"],"description":"This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n","title":"CreateOrderResumeResumePeriodsType"},"CreateOrderResumeResumePolicy":{"type":"string","enum":["Today","FixedPeriodsFromSuspendDate","FixedPeriodsFromToday","SpecificDate","SuspendDate"],"description":"Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n","title":"CreateOrderResumeResumePolicy"},"CreateOrderResume":{"type":"object","properties":{"extendsTerm":{"type":"boolean","description":"Specifies whether to extend the subscription term by the length of time the suspension is in effect.\n"},"resumePeriods":{"type":"integer","description":"This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriodsType` field. \n\nThe total number of the periods used to specify when a subscription resumption takes effect. The subscription resumption will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"},"resumePeriodsType":{"$ref":"#/components/schemas/CreateOrderResumeResumePeriodsType","description":"This field is applicable only when the `resumePolicy` field is set to `FixedPeriodsFromToday` or `FixedPeriodsFromSuspendDate`. It must be used together with the `resumePeriods` field.\n\nThe period type used to specify when a subscription resumption takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"},"resumePolicy":{"$ref":"#/components/schemas/CreateOrderResumeResumePolicy","description":"Resume methods. Specify a way to resume a subscription. See [Resume Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Resume_a_Subscription#Resume_Date) for more information.\n\nIf `SuspendDate` is specfied, the resumption will take place on the same day as the suspension. \n"},"resumeSpecificDate":{"type":"string","format":"date","description":"This field is applicable only when the `resumePolicy` field is set to `SpecificDate`.\n\nA specific date when the subscription resumption takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription suspension date.\n"}},"required":["resumePolicy"],"description":"Information about an order action of type `Resume`.\n","title":"CreateOrderResume"},"CreateOrderSuspendSuspendPeriodsType":{"type":"string","enum":["Day","Week","Month","Year"],"description":"This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n","title":"CreateOrderSuspendSuspendPeriodsType"},"CreateOrderSuspendSuspendPolicy":{"type":"string","enum":["Today","EndOfLastInvoicePeriod","FixedPeriodsFromToday","SpecificDate"],"description":"Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information.\n","title":"CreateOrderSuspendSuspendPolicy"},"CreateOrderSuspend":{"type":"object","properties":{"suspendPeriods":{"type":"integer","description":"This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriodsType` field. \n\nThe total number of the periods used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"},"suspendPeriodsType":{"$ref":"#/components/schemas/CreateOrderSuspendSuspendPeriodsType","description":"This field is applicable only when the `suspendPolicy` field is set to `FixedPeriodsFromToday`. It must be used together with the `suspendPeriods` field.\n\nThe period type used to specify when a subscription suspension takes effect. The subscription suspension will take place after the specified time frame (`suspendPeriods` multiplied by `suspendPeriodsType`) from today's date. \n"},"suspendPolicy":{"$ref":"#/components/schemas/CreateOrderSuspendSuspendPolicy","description":"Suspend methods. Specify a way to suspend a subscription. See [Suspend Date](https://knowledgecenter.zuora.com/BC_Subscription_Management/Subscriptions/Suspend_a_Subscription#Suspend_Date) for more information.\n"},"suspendSpecificDate":{"type":"string","format":"date","description":"This field is applicable only when the `suspendPolicy` field is set to `SpecificDate`.\n\nA specific date when the subscription suspension takes effect, in YYYY-MM-DD format. The value should not be earlier than the subscription's contract effective date or later [available versions](https://developer.zuora.com/api-references/api/overview/#section/API-Versions/Minor-Version) than the subscription's term end date.\n"}},"required":["suspendPolicy"],"description":"Information about an order action of type `Suspend`.\n","title":"CreateOrderSuspend"},"LastTermPeriodType":{"type":"string","enum":["Month","Year","Day","Week"],"description":"Specify only when the termType is 'TERMED'.","title":"LastTermPeriodType"},"LastTermTermType":{"type":"string","enum":["TERMED","EVERGREEN"],"title":"LastTermTermType"},"LastTerm":{"type":"object","properties":{"period":{"type":"integer","minimum":0,"description":"Specify only when the termType is 'TERMED'."},"periodType":{"$ref":"#/components/schemas/LastTermPeriodType","description":"Specify only when the termType is 'TERMED'."},"startDate":{"type":"string","format":"date","description":"The start date of the current term. You can change the term start date of a renewed subscription through a T&Cs order action. However, when changing it to an earlier date, this date must not be earlier than the term start date of the current term before this T&Cs.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the current term, in YYYY-MM-DD format.\n"},"termType":{"$ref":"#/components/schemas/LastTermTermType"}},"required":["termType"],"description":"The length of the period for the current subscription term.","title":"LastTerm"},"CreateOrderTermsAndConditionsPaymentProfile":{"type":"object","properties":{"paymentGatewayId":{"type":"string","description":"The ID of the gateway instance that processes the payment.\n\nThis field remains unset, if you do not provide value.\n"},"paymentMethodId":{"type":"string","description":"The ID of the payment method.\n\nThis field remains unset, if you do not provide value.\n"}},"description":"Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription.\n\n**Note:**\n - If multiple order actions are specified, they will be applied in the same order they appear in the API payload.\n - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element.\n","title":"CreateOrderTermsAndConditionsPaymentProfile"},"CreateOrderTermsAndConditionsRenewalSetting":{"type":"string","enum":["RENEW_WITH_SPECIFIC_TERM","RENEW_TO_EVERGREEN"],"title":"CreateOrderTermsAndConditionsRenewalSetting"},"CreateOrderTermsAndConditions":{"type":"object","properties":{"autoRenew":{"type":"boolean"},"billToContactId":{"type":"string","description":"The ID of the bill-to contact associated with the subscription.\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"},"clearingExistingBillToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing bill-to contact ID at the subscription level. This field is mutually exclusive with the `billToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingInvoiceGroupNumber":{"type":"boolean","default":false,"description":"Whether to clear the existing invoice group number at the subscription level. This field is mutually exclusive with the `invoiceGroupNumber` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingInvoiceTemplate":{"type":"boolean","default":false,"description":"Whether to clear the existing invoice template ID at the subscription level. This field is mutually exclusive with the `invoiceTemplateId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingPaymentTerm":{"type":"boolean","default":false,"description":"Whether to clear the existing payment term at the subscription level. This field is mutually exclusive with the `paymentTerm` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingSequenceSet":{"type":"boolean","default":false,"description":"Whether to clear the existing sequence set ID at the subscription level. This field is mutually exclusive with the `sequenceSetId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"clearingExistingShipToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing ship-to contact ID at the subscription level. This field is mutually exclusive with the `shipToContactId` field.\n\n**Note**:\n To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support.\n"},"clearingExistingSoldToContact":{"type":"boolean","default":false,"description":"Whether to clear the existing sold-to contact ID at the subscription level. This field is mutually exclusive with the `soldToContactId` field.\n\n**Note**: If you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-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.\n"},"communicationProfileId":{"type":"string","description":"The ID of the communication profile associated with the subscription.\n\n**Note**: This field is available in the request body only if you have the Flexible Billing Attributes\n feature turned on. The value is `null` in the response body without this feature turned on.\n"},"clearingExistingCommunicationProfile":{"type":"boolean","default":false,"description":"Whether to clear the existing communication profile at the subscription\nlevel. This field is mutually exclusive with the `communicationProfileId` field.\n"},"invoiceGroupNumber":{"type":["string","null"],"maxLength":255,"description":"The number of the invoice group associated with the subscription.\n\nAfter enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see [Invoice Grouping](https://knowledgecenter.zuora.com/Billing/Subscriptions/Invoice_Grouping).\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to `null` in the response body.\n"},"invoiceSeparately":{"type":"boolean","description":"Specifies whether the subscription appears on a separate invoice while generating invoices."},"invoiceTemplateId":{"type":"string","description":"The ID of the invoice template associated with the subscription.\n\n**Note**: \n - 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. \n - 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.\n"},"lastTerm":{"$ref":"#/components/schemas/LastTerm"},"paymentProfile":{"$ref":"#/components/schemas/CreateOrderTermsAndConditionsPaymentProfile","description":"Container for payment gateway and payment method details of a payment. If you do not set this field, the payment method and payment gateway values cannot be set in the subscription.\n\n**Note:**\n - If multiple order actions are specified, they will be applied in the same order they appear in the API payload.\n - If one or more of these order actions include the `paymentProfile` element, the changes will be applied in sequence, and the result will be consistent with the last `paymentProfile` element.\n"},"paymentTerm":{"type":"string","description":"The name of the payment term associated with the subscription. For example, `Net 30`. The payment term determines the due dates of invoices.\n\n**Note**: \n - 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. \n - 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.\n"},"renewalSetting":{"$ref":"#/components/schemas/CreateOrderTermsAndConditionsRenewalSetting"},"renewalTerms":{"type":"array","items":{"$ref":"#/components/schemas/RenewalTerm"}},"scheduledCancelDate":{"type":"string","format":"date","description":"The date when the subscription is scheduled to be canceled. The subscription is not canceled until the date specified in this field.\n"},"scheduledSuspendDate":{"type":"string","format":"date","description":"The date when the subscription is scheduled to be suspended. The subscription is not suspended until the date specified in this field. \n"},"scheduledResumeDate":{"type":"string","format":"date","description":"The date when the subscription is scheduled to be resumed. The subscription is not resumed until the date specified in this field. \n"},"clearingScheduledCancelDate":{"type":"boolean","default":false,"description":"Whether to clear the value of the `scheduledCancelDate` field. \n\n**Note**: Do not set this field and the `scheduledCancelDate` field simultaneously. \n"},"clearingScheduledSuspendDate":{"type":"boolean","default":false,"description":"Whether to clear the value of the `scheduledSuspendDate` field. \n\n**Note**: Do not set this field and the `scheduledSuspendDate` field simultaneously. \n"},"clearingScheduledResumeDate":{"type":"boolean","default":false,"description":"Whether to clear the value of the `scheduledResumeDate` field.\n\n**Note**: Do not set this field and the `scheduledResumeDate` field simultaneously. \n"},"sequenceSetId":{"type":"string","description":"The ID of the sequence set associated with the subscription.\n\n**Note**: \n - 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. \n - 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.\n"},"shipToContactId":{"type":"string","description":"The ID of the ship-to contact associated with the subscription.\n\n**Note**:\n To access this field, you must have the ShipToContactSupport permission. If you want to enable this permission, submit a request at Zuora Global Support.\n"},"soldToContactId":{"type":"string","description":"The ID of the sold-to contact associated with the subscription.\n\n**Note**: \n - 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. \n - If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request or you select **Default Contact from Account** for this field during subscription creation, the value of this field is automatically set to `null` in the response body.\n"}},"description":"Information about an order action of type `TermsAndConditions`.\n","title":"CreateOrderTermsAndConditions"},"TriggerDateName":{"type":"string","enum":["ContractEffective","ServiceActivation","CustomerAcceptance"],"description":"Name of the trigger date of the order action.\n","title":"TriggerDateName"},"TriggerDate":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/TriggerDateName","description":"Name of the trigger date of the order action.\n"},"triggerDate":{"type":"string","format":"date","description":"Trigger date in YYYY-MM-DD format.\n"}},"title":"TriggerDate"},"PreviewOrderOrderActionType":{"type":"string","enum":["CreateSubscription","TermsAndConditions","AddProduct","UpdateProduct","RemoveProduct","RenewSubscription","CancelSubscription","OwnerTransfer","Suspend","Resume","ChangePlan"],"description":"Type of order action.\n\nUnless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.\n\nZuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.\n\n**Note**: The change plan type of order action is supported for the Order to Revenue feature. However, it is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n","title":"PreviewOrderOrderActionType"},"BillingUpdateBillingPeriodAlignment":{"type":"string","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"description":"**Note**: This field is not supported in one time charges.\n","title":"BillingUpdateBillingPeriodAlignment"},"BillingUpdate":{"type":"object","properties":{"billingPeriodAlignment":{"$ref":"#/components/schemas/BillingUpdateBillingPeriodAlignment","description":"**Note**: This field is not supported in one time charges.\n"}},"title":"BillingUpdate"},"DiscountPricingUpdateApplyDiscountTo":{"type":"string","enum":["ONETIME","RECURRING","USAGE","ONETIMERECURRING","ONETIMEUSAGE","RECURRINGUSAGE","ONETIMERECURRINGUSAGE"],"description":"Specifies which type of charge the discount charge applies to.\n","title":"DiscountPricingUpdateApplyDiscountTo"},"DiscountPricingUpdateDiscountLevel":{"type":"string","enum":["rateplan","subscription","account"],"description":"Application scope of the discount charge. 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.\n","title":"DiscountPricingUpdateDiscountLevel"},"DiscountPricingUpdatePriceChangeOption":{"type":"string","enum":["NoChange","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n","title":"DiscountPricingUpdatePriceChangeOption"},"DiscountPricingUpdate":{"type":"object","properties":{"applyDiscountTo":{"$ref":"#/components/schemas/DiscountPricingUpdateApplyDiscountTo","description":"Specifies which type of charge the discount charge applies to.\n"},"discountLevel":{"$ref":"#/components/schemas/DiscountPricingUpdateDiscountLevel","description":"Application scope of the discount charge. 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.\n"},"discountPercentage":{"type":"number","format":"double","description":"The amount of the discount as a percentage. This field is only used for percentage discounts.\n"},"originalListDiscountPercentage":{"type":"number","format":"double","description":"The original discount percentage listed for sale by a manufacturer or retailer.\n"},"priceChangeOption":{"$ref":"#/components/schemas/DiscountPricingUpdatePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n"}},"title":"DiscountPricingUpdate"},"RecurringCalculatedPricingUpdate":{"type":"object","properties":{"clearingExistingMinimumAmount":{"type":"boolean","description":"Set it to `true` to reset the minimum amount to null.\n"},"clearingExistingMaximumAmount":{"type":"boolean","description":"Set it to `true` to reset the maximum amount to null.\n"},"minimumAmount":{"type":"number","format":"double","description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n"},"maximumAmount":{"type":"number","format":"double","description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n"},"percentage":{"type":"number","format":"double","description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied.\n"}},"required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"RecurringCalculatedPricingUpdate"},"RecurringFlatFeePricingUpdatePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"RecurringFlatFeePricingUpdatePriceChangeOption"},"RecurringFlatFeePricingUpdate":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/RecurringFlatFeePricingUpdatePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"listPrice":{"type":"number","format":"double"},"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.\n"}},"title":"RecurringFlatFeePricingUpdate"},"RecurringPerUnitPricingUpdatePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"RecurringPerUnitPricingUpdatePriceChangeOption"},"RecurringPerUnitPricingUpdate":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/RecurringPerUnitPricingUpdatePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"listPrice":{"type":"number","format":"double"},"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.\n"},"quantity":{"type":"number","format":"double","minimum":0}},"title":"RecurringPerUnitPricingUpdate"},"RecurringTieredPricingUpdatePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"RecurringTieredPricingUpdatePriceChangeOption"},"RecurringTieredPricingUpdate":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/RecurringTieredPricingUpdatePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"quantity":{"type":"number","format":"double","minimum":0},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ChargeTier"}}},"title":"RecurringTieredPricingUpdate"},"RecurringVolumePricingUpdatePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"RecurringVolumePricingUpdatePriceChangeOption"},"RecurringVolumePricingUpdate":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/RecurringVolumePricingUpdatePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"quantity":{"type":"number","format":"double","minimum":0},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ChargeTier"}}},"title":"RecurringVolumePricingUpdate"},"PreviewOrderPricingUpdate":{"type":"object","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride","description":"Container for charge model configuration data.\n\n**Note**: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricing charge models enabled. The High Water Mark and Pre-Rated Pricing charge models are available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information.\n"},"discount":{"$ref":"#/components/schemas/DiscountPricingUpdate","description":"Pricing information about a discount charge.\n"},"recurringCalcualated":{"$ref":"#/components/schemas/RecurringCalculatedPricingUpdate"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingUpdate","description":"Pricing information about a recurring charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingUpdate","description":"Pricing information about a recurring charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit purchased.\n"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingUpdate","description":"Pricing information about a recurring charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are purchased.\n"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingUpdate","description":"Pricing information about a recurring charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are purchased.\n"}},"title":"PreviewOrderPricingUpdate"},"PreviewOrderChargeUpdate":{"type":"object","properties":{"billing":{"$ref":"#/components/schemas/BillingUpdate"},"chargeNumber":{"type":"string","description":"The number of the charge to be updated. The value of this field is inherited from the `subscriptions` > `orderActions` > `addProduct` > `chargeOverrides` > `chargeNumber` field.\n"},"customFields":{"$ref":"#/components/schemas/RatePlanChargeObjectCustomFields"},"description":{"type":"string"},"effectiveDate":{"$ref":"#/components/schemas/PreviewOrderTriggerParams"},"estimatedStartDate":{"type":"string","format":"date","description":"The estimated start date of the pending charge in an active subscription.\n\nThe value of this field 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.\n\n**Note:** This field is available only when the Pending Subscription Processing feature is turned on.\n"},"negotiatedPriceTable":{"type":"array","items":{"$ref":"#/components/schemas/NegotiatedItems"},"description":"Array of negotiated price table information. The rate card entries provided in the array will override the existing rate card entries in the standard price table to form a negotiated price table that will be \nused during pricing evaluation.\n\n\n**Note:** To enable the Negotiated Price Table feature, submit a request to Zuora Global Support. \n"},"prepaidQuantity":{"type":"number","format":"double","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.\n\nThe 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). \n"},"pricingAttributes":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Container for pricing attribute and value that provide additional context for dynamic pricing. The pricing attribute values included in the array will update the existing values. For the pricing attribute mapped to a Zuora object field, Zuora will retrieve the value automatically, you don’t need to pass its value explicitly. If you pass a value that doesn’t match the actual value of the Zuora object, an error will be returned.\nNote that for any pricing attribute mapped to the field of Zuora object Usage, because its value is only determined when the usage record arrives, you can’t provide a value via Orders API payload and Zuora will not retrieve its value automatically.\n\n\n\n**Note:** To enable Dynamic Pricing, submit a request to Zuora Global Support. \n"},"pricing":{"$ref":"#/components/schemas/PreviewOrderPricingUpdate","description":"Pricing information about the charge.\n"},"productRatePlanChargeId":{"type":"string","description":"ID of a product rate plan charge for this subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeId` is added to the existing rate plan specified by `ratePlanId`.\n"},"productRatePlanChargeNumber":{"type":"string","description":"Number of a product rate plan charge for this subscription. When `isAddingSubsetCharges` is set to true, the product rate charge specified by `productRatePlanChargeNumber` is added to the existing rate plan specified by `ratePlanId`.\n"},"uniqueToken":{"type":"string","description":"A unique string to represent the rate plan charge in the order. The unique token is used to perform multiple actions against a newly added rate plan charge. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan charge and use that token in future order actions.\n"}},"title":"PreviewOrderChargeUpdate"},"PreviewOrderRatePlanUpdate":{"type":"object","properties":{"chargeUpdates":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderChargeUpdate"},"description":"Array of the JSON objects containing the information for a charge update in the `updateProduct` type of order action.\n\nWhen previewing an `updateProduct` order action, either the `chargeNumber` or `uniqueToken` field is required to specify the charge to update.\n"},"clearingExistingFeatures":{"type":"boolean","description":"Specifies whether all features in the rate plan will be cleared.\n"},"customFields":{"$ref":"#/components/schemas/OrdersRatePlanObjectCustomFields"},"isAddingSubsetCharges":{"type":"boolean","description":"Specifies whether to add a subset of charges to the subscription.\n\n\n**Note:** To access this field for adding a subset of charges, submit a request at Zuora Global Support.\n"},"productRatePlanNumber":{"type":"string","description":"Number of a product rate plan for this subscription.\n"},"ratePlanId":{"type":"string","description":"The id of the rate plan to be updated. It can be the latest version or any history version id.\n"},"specificUpdateDate":{"type":"string","format":"date","description":"The specific date when the Update Product order action takes effect. This field allows you to update a charge before a future-dated Update Product order action on the subscription. The format of the date is yyyy-mm-dd.\n\n**Note**: After you use this option, the charge's `TriggerEvent` field value will be changed to `SpecificDate`. \n\nSee [Update a Product on Subscription with Future-dated Updates](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AC_Orders_Tutorials/C_Update_a_Product_in_a_Subscription/Update_a_Product_on_Subscription_with_Future-dated_Updates) for more information about this feature.\n"},"subscriptionProductFeatures":{"type":"array","items":{"$ref":"#/components/schemas/CreateOrderRatePlanFeatureOverride"},"description":"List of features associated with the rate plan.\nThe system compares the `subscriptionProductFeatures` and `featureId` fields in the request with the counterpart fields in a rate plan. The comparison results are as follows:\n* If there is no `subscriptionProductFeatures` field or the field is empty, features in the rate plan remain unchanged. But if the `clearingExistingFeatures` field is additionally set to true, all features in the rate plan are cleared.\n* If the `subscriptionProductFeatures` field contains the `featureId` nested fields, as well as the optional `description` and `customFields` nested fields, the features indicated by the featureId nested fields in the request overwrite all features in the rate plan.\n"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a rate plan for this subscription.\n"},"uniqueToken":{"type":"string","description":"A unique string to represent the rate plan in the order. The unique token is used to perform multiple actions against a newly added rate plan. For example, if you want to add and update a product in the same order, assign a unique token to the newly added rate plan and use that token in future order actions.\n"}},"description":"Information about an order action of type `UpdateProduct`.\n","title":"PreviewOrderRatePlanUpdate"},"PreviewOrderOrderAction":{"type":"object","properties":{"addProduct":{"$ref":"#/components/schemas/PreviewOrderRatePlanOverride"},"cancelSubscription":{"$ref":"#/components/schemas/CancelSubscription"},"changePlan":{"$ref":"#/components/schemas/PreviewOrderCreateChangePlan"},"changeReason":{"type":"string","description":"The change reason set for an order action when an order is created.\n"},"createSubscription":{"$ref":"#/components/schemas/PreviewOrderCreateSubscription"},"customFields":{"$ref":"#/components/schemas/OrderActionObjectCustomFields"},"ownerTransfer":{"$ref":"#/components/schemas/OwnerTransfer"},"removeProduct":{"$ref":"#/components/schemas/RemoveProduct"},"renewSubscription":{"$ref":"#/components/schemas/RenewSubscription"},"resume":{"$ref":"#/components/schemas/CreateOrderResume"},"suspend":{"$ref":"#/components/schemas/CreateOrderSuspend"},"termsAndConditions":{"$ref":"#/components/schemas/CreateOrderTermsAndConditions"},"triggerDates":{"type":"array","items":{"$ref":"#/components/schemas/TriggerDate"},"description":"Container for the contract effective, service activation, and customer acceptance dates of the order action. \n\nIf the service activation date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Activation` subscription.\n\nIf the customer acceptance date is set as a required field in Default Subscription Settings, skipping this field in a `CreateSubscription` order action of your JSON request will result in a `Pending` order and a `Pending Acceptance` subscription. If the service activation date field is at the same time required and skipped (or set as null), it will be a `Pending Activation` subscription.\n"},"type":{"$ref":"#/components/schemas/PreviewOrderOrderActionType","description":"Type of order action.\n\nUnless the type of order action is `RenewSubscription`, you must use the corresponding field to provide information about the order action. For example, if the type of order action is `AddProduct`, you must set the `addProduct` field.\n\nZuora returns an error if you set a field that corresponds to a different type of order action. For example, if the type of order action is `AddProduct`, Zuora returns an error if you set the `updateProduct` field.\n\n**Note**: The change plan type of order action is supported for the Order to Revenue feature. However, it is currently not supported for the Billing - Revenue Integration feature. When Billing - Revenue Integration is enabled, the change plan type of order action will no longer be applicable in Zuora Billing.\n"},"updateProduct":{"$ref":"#/components/schemas/PreviewOrderRatePlanUpdate"}},"required":["type"],"title":"PreviewOrderOrderAction"},"QuoteObjectFields":{"type":"object","properties":{"OpportunityCloseDate__QT":{"type":"string","description":"The closing date of the Opportunity.\n\nThis field is used in Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n"},"OpportunityName__QT":{"type":"string","description":"The unique identifier of the Opportunity. \n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 100\n"},"QuoteBusinessType__QT":{"type":"string","description":"The specific identifier for the type of business transaction the Quote represents such as New, Upsell, Downsell, Renewal or Churn.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"},"QuoteNumber__QT":{"type":"string","description":"The unique identifier of the Quote.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"},"QuoteType__QT":{"type":"string","description":"The Quote type that represents the subscription lifecycle stage such as New, Amendment, Renew or Cancel.\n\nThis field is used in the Zuora Reporting Data Sources to report on Subscription metrics.\n\nIf the subscription was originated from Zuora Quotes, the value is populated with the value from Zuora Quotes.\n\n**Character limit**: 32\n"}},"description":"The fields populated for a quote when a quote is sent to Zuora Billing from Zuora Quote.\n","title":"QuoteObjectFields"},"RampChargeRequest":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The number of the rate plan charge."},"uniqueToken":{"type":"string","description":"Unique identifier for the charge. This identifier enables you to refer to the charge before the charge has an internal identifier in Zuora.\n"}},"title":"RampChargeRequest"},"RampIntervalRequest":{"type":"object","properties":{"description":{"type":"string","description":"The short description of the interval."},"endDate":{"type":"string","format":"date","description":"The end date of the interval."},"name":{"type":"string","description":"The name of the interval."},"startDate":{"type":"string","format":"date","description":"The start date of the interval."}},"required":["endDate","startDate"],"description":"Container for the intervals that the ramp is split into in its timeline. Zuora can report metrics for this specific period.\n","title":"RampIntervalRequest"},"RampRequest":{"type":"object","properties":{"charges":{"type":"array","items":{"$ref":"#/components/schemas/RampChargeRequest"},"description":"Container for the rate plan charges that are considered as part of the ramp deal.\n\n* If this field is not specified, all the one-time and recurring regular charges of the new subscription are automatically considered as part of the ramp deal.\n* If this field is specified, either 'chargeNumber' or 'uniqueToken' must be specified.\n"},"delete":{"type":"boolean","description":"Whether to remove the ramp definition from the new subscription. If you want to remove the ramp definition, this field is the only required field for the `ramp` object. \n"},"description":{"type":"string","description":"The short description of the ramp."},"intervals":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalRequest"},"description":"Container for the intervals that the ramp is split into in its timeline. \n\nIt is required when you want to create or update the ramp definition. The ramp intervals cannot have any overlap or gap between each other.\n"},"name":{"type":"string","description":"The name of the ramp."}},"description":"Container of the ramp definitions. It is used to create, update, or remove the ramp definition for the new subscription.\n","title":"RampRequest"},"PostOrderPreviewRequestTypeSubscriptionsItems":{"type":"object","properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"type":"string","maxLength":1000,"description":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the `notes` field within the createSubscription order action.\n"},"orderActions":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderOrderAction"},"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"type":"string","description":"Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n"}},"title":"PostOrderPreviewRequestTypeSubscriptionsItems"},"POSTOrderPreviewRequestType":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/PostOrderPreviewRequestTypeCategory","default":"NewSales","description":"Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"type":"string","maxLength":500,"description":"A description of the order."},"existingAccountId":{"type":"string","description":"The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field. \n\n**Note:** You can specify either the `existingAccountNumber` or `existingAccountId` field, but not both.\n"},"existingAccountNumber":{"type":"string","maxLength":70,"description":"The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field.\n"},"orderDate":{"type":"string","format":"date","description":"The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date."},"orderLineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"description":"[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\nIf you do not have the **Create Order Line Items Without Product Catalog** billing permission, you can only create order line items from existing products by specifying the product rate plan charge ID in the `productRatePlanChargeId` field. For more information about billing permissions, see Billing Roles.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"},"orderNumber":{"type":"string","maxLength":100,"description":"The order number of this order. \n**Note:** The characters `#`, `?`, and `/` are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: `_`,`-`, `.`, `~`, `*`, `(`, `)`, and `'`.\n"},"previewAccountInfo":{"$ref":"#/components/schemas/PreviewAccountInfo"},"previewOptions":{"$ref":"#/components/schemas/PreviewOptions"},"reasonCode":{"type":"string","maxLength":255,"description":"Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderPreviewRequestTypeSubscriptionsItems"},"description":"Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. "}},"required":["orderDate","previewOptions"],"title":"POSTOrderPreviewRequestType"},"PostOrderPreviewResponseTypeReasonsItems":{"type":"object","properties":{"code":{"type":"string","description":"The error code of response.\n"},"message":{"type":"string","description":"The detail information of the error response\n"}},"title":"PostOrderPreviewResponseTypeReasonsItems"},"ChargePreviewMetricsCmrr":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"Total discountCmrr of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order. Only selects the applied discount charge when its endDateCondition is \"Subscription_End\"."},"discountDelta":{"type":"number","format":"double","description":"Delta discountCmrr value between the order base and the latest subscription version."},"regular":{"type":"number","format":"double"},"regularDelta":{"type":"number","format":"double"}},"title":"ChargePreviewMetricsCmrr"},"ChargePreviewMetricsTax":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"Total tax amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order."},"discountDelta":{"type":"number","format":"double","description":"Delta discount TAX value between the base and the latest subscription version in the order for the specific recurring charge."},"regular":{"type":"number","format":"double"},"regularDelta":{"type":"number","format":"double","description":"Delta tax value between the base and the latest subscription version in the order."}},"title":"ChargePreviewMetricsTax"},"ChargePreviewMetricsTcb":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"Total contract billing amount of all discount charges which are applied to one specific recurring charge. This value is calculated from the rating results for the latest subscription version in the order."},"discountDelta":{"type":"number","format":"double","description":"Delta discount TCB value between the base and the latest subscription version for specific recurring charge in the order."},"regular":{"type":"number","format":"double"},"regularDelta":{"type":"number","format":"double","description":"Delta TCB value between the base and the latest subscription version in the order."}},"title":"ChargePreviewMetricsTcb"},"ChargePreviewMetricsTcv":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"Always equals to discountTcb."},"discountDelta":{"type":"number","format":"double","description":"Always equals to delta discountTcb."},"regular":{"type":"number","format":"double"},"regularDelta":{"type":"number","format":"double"}},"title":"ChargePreviewMetricsTcv"},"ChargePreviewMetrics":{"type":"object","properties":{"chargeNumber":{"type":"string"},"cmrr":{"$ref":"#/components/schemas/ChargePreviewMetricsCmrr"},"originRatePlanId":{"type":"string"},"productRatePlanChargeId":{"type":"string"},"productRatePlanId":{"type":"string"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a subscription rate plan for this subscription.\n"},"tax":{"$ref":"#/components/schemas/ChargePreviewMetricsTax"},"tcb":{"$ref":"#/components/schemas/ChargePreviewMetricsTcb"},"tcv":{"$ref":"#/components/schemas/ChargePreviewMetricsTcv"}},"title":"ChargePreviewMetrics"},"PreviewOrderResultChargeMetricsItems":{"type":"object","properties":{"charges":{"type":"array","items":{"$ref":"#/components/schemas/ChargePreviewMetrics"}},"subscriptionNumber":{"type":"string","description":"The number of the subscription that has been affected by this order. When creating a subscription, this value will not show if the subscription number was not specified in the request."}},"title":"PreviewOrderResultChargeMetricsItems"},"InvoiceItemPreviewResultAdditionalInfo":{"type":"object","properties":{"numberOfDeliveries":{"type":"number","format":"double","description":"The number of deliveries dedicated to the Delivery Pricing charges. \n**Note**: This field is available only if you have the Delivery Pricing feature enabled.\n"},"quantity":{"type":"number","format":"double"},"unitOfMeasure":{"type":"string"}},"title":"InvoiceItemPreviewResultAdditionalInfo"},"InvoiceItemPreviewResultProcessingType":{"type":"string","enum":["Charge","Discount","Tax"],"title":"InvoiceItemPreviewResultProcessingType"},"InvoiceItemPreviewResultTaxationItemsItemsTaxRateType":{"type":"string","enum":["Percentage","FlatFee"],"description":"Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n","title":"InvoiceItemPreviewResultTaxationItemsItemsTaxRateType"},"InvoiceItemPreviewResultTaxationItemsItems":{"type":"object","properties":{"exemptAmount":{"type":"number","format":"double","description":"The calculated tax amount excluded due to the exemption.\n"},"id":{"type":"string","description":"The ID of the taxation item.\n"},"jurisdiction":{"type":"string","description":"The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.\n"},"locationCode":{"type":"string","description":"The identifier for the location based on the value of the taxCode field.\n"},"name":{"type":"string","description":"The name of the taxation item.\n"},"taxAmount":{"type":"number","format":"double","description":"The amount of the tax applied to the invoice.\n"},"taxCode":{"type":"string","description":"The tax code identifies which tax rules and tax rates to apply to a specific invoice.\n"},"taxCodeDescription":{"type":"string","description":"The description of the tax code.\n"},"taxDate":{"type":"string","description":"The date when the tax is applied to the invoice.\n"},"taxRate":{"type":"number","format":"double","description":"The tax rate applied to the invoice.\n"},"taxRateDescription":{"type":"string","description":"The description of the tax rate.\n"},"taxRateType":{"$ref":"#/components/schemas/InvoiceItemPreviewResultTaxationItemsItemsTaxRateType","description":"Enum:\"Percentage\" \"FlatFee\". The type of the tax rate applied to the invoice.\n"}},"title":"InvoiceItemPreviewResultTaxationItemsItems"},"InvoiceItemPreviewResult":{"type":"object","properties":{"additionalInfo":{"$ref":"#/components/schemas/InvoiceItemPreviewResultAdditionalInfo"},"amountWithoutTax":{"type":"number","format":"double"},"appliedToChargeNumber":{"type":"string","description":"Available when the chargeNumber of the charge that discount applies to was specified in the request or when the order is amending an existing subscription."},"chargeDescription":{"type":"string"},"chargeName":{"type":"string"},"chargeNumber":{"type":["string","null"],"description":"Available when the `chargeNumber` field was specified in the request or when the order is amending an existing subscription."},"orderLineItemNumber":{"type":["string","null"],"description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\"."},"processingType":{"$ref":"#/components/schemas/InvoiceItemPreviewResultProcessingType"},"productName":{"type":"string"},"productRatePlanChargeId":{"type":"string","description":"The product rate plan charge ID in this `productRatePlanChargeId` field belongs to a product rate plan specified through the `subscribeToRatePlans` > `productRatePlanId` field. \nTherefore, this `productRatePlanChargeId` field has a value only when the `subscribeToRatePlans` > `productRatePlanId` field is specified during the subscription creation. \nThis `productRatePlanChargeId` field does not indicate a product rate plan charge associated with an order line item.\n"},"serviceEndDate":{"type":"string","format":"date"},"serviceStartDate":{"type":"string","format":"date"},"subscriptionNumber":{"type":["string","null"],"description":"The number of the subscription.\n"},"taxAmount":{"type":"number","format":"double"},"taxationItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemPreviewResultTaxationItemsItems"},"description":"List of taxation items.\n\n**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 `309.0` or [a later available version](https://developer.zuora.com/v1-api-reference/api-versions/#minor-version).\n"},"unitPrice":{"type":"number","format":"double","description":"The per-unit price of the invoice item.\n"}},"title":"InvoiceItemPreviewResult"},"PreviewOrderResultCreditMemosItems":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"amountWithoutTax":{"type":"number","format":"double"},"creditMemoItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemPreviewResult"}},"targetDate":{"type":"string","format":"date"},"taxAmount":{"type":"number","format":"double"}},"title":"PreviewOrderResultCreditMemosItems"},"InvoiceItemSummary":{"type":"object","properties":{"previewInvoiceSequence":{"type":"number","format":"double","description":"The sequence number of the invoice to be billed.\n"},"subTotal":{"type":"number","format":"double","description":"The aggregated subtotal amount of the invoice.\n"},"discountAmount":{"type":"number","format":"double","description":"The aggregated discount amount of the invoice.\n"},"taxAmount":{"type":"number","format":"double","description":"The aggregated tax amount of the invoice.\n"},"total":{"type":"number","format":"double","description":"The aggregated total amount of the invoice.\n"},"servicePeriodStartDate":{"type":"string","format":"date","description":"The start date of the period being billed.\n"},"servicePeriodEndDate":{"type":"string","format":"date","description":"The end date of the period being billed.\n"}},"title":"InvoiceItemSummary"},"PreviewOrderResultInvoicesItems":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The total amount of the invoice.\n"},"amountWithoutTax":{"type":"number","format":"double","description":"The amount of the invoice without tax.\n"},"invoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemPreviewResult"},"description":"The invoice items on the invoice.\n"},"targetDate":{"type":"string","format":"date","description":"The target date to bill the invoice.\n"},"taxAmount":{"type":"number","format":"double","description":"The total tax amount of the invoice.\n"},"invoiceItemSummary":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemSummary"},"description":"The aggregated summary data for all future invoices to be billed within the preview period.\n\nThis field is returned only if you set the `summarizeInvoiceItem` query parameter to `true`.\n"}},"title":"PreviewOrderResultInvoicesItems"},"OrderDeltaMrr":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"currency":{"type":"string","description":"ISO 3-letter currency code (uppercase). For example, USD.\n"},"endDate":{"type":"string","format":"date","description":"The end date for the order delta metric.\n"},"grossAmount":{"type":"number","format":"double","description":"The gross amount for the metric. The is the amount excluding applied discount.\n"},"netAmount":{"type":"number","format":"double","description":"The net amount for the metric. The is the amount with discounts applied\n"},"orderActionId":{"type":"string","description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionSequence":{"type":"string","description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionType":{"type":"string","description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderLineItemNumber":{"type":"string","description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\".\n"},"productRatePlanChargeId":{"type":"string","description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n"},"ratePlanChargeId":{"type":"string","description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"startDate":{"type":"string","format":"date","description":"The start date for the order delta metric.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n"}},"description":"Order Delta Mrr. This is a metric that reflects the change to the TCV on rate plan charge object as the result of the order.\n","title":"OrderDeltaMrr"},"OrderDeltaTcb":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"currency":{"type":"string","description":"ISO 3-letter currency code (uppercase). For example, USD.\n"},"endDate":{"type":"string","format":"date","description":"The end date for the order delta metric.\n"},"grossAmount":{"type":"number","format":"double","description":"The gross amount for the metric. The is the amount excluding applied discount.\n"},"netAmount":{"type":"number","format":"double","description":"The net amount for the metric. The is the amount with discounts applied\n"},"orderActionId":{"type":"string","description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionSequence":{"type":"string","description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionType":{"type":"string","description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderLineItemNumber":{"type":"string","description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\".\n"},"productRatePlanChargeId":{"type":"string","description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n"},"ratePlanChargeId":{"type":"string","description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"startDate":{"type":"string","format":"date","description":"The start date for the order delta metric.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n"},"orderLineItemId":{"type":"string","format":"UUID","description":"The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for a Rate Plan Charge.\n"}},"description":"Order Delta Tcb. This is a metric that reflects the change to the estimated billing on Rate Plan Charge object, or the estimated billing for an Order Line Item as the result of the order\n","title":"OrderDeltaTcb"},"OrderDeltaTcv":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The charge number for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"currency":{"type":"string","description":"ISO 3-letter currency code (uppercase). For example, USD.\n"},"endDate":{"type":"string","format":"date","description":"The end date for the order delta metric.\n"},"grossAmount":{"type":"number","format":"double","description":"The gross amount for the metric. The is the amount excluding applied discount.\n"},"netAmount":{"type":"number","format":"double","description":"The net amount for the metric. The is the amount with discounts applied\n"},"orderActionId":{"type":"string","description":"The Id for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionSequence":{"type":"string","description":"The sequence for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderActionType":{"type":"string","description":"The type for the related Order Action. This field can be null if the metric is generated for an Order Line Item.\n"},"orderLineItemNumber":{"type":"string","description":"A sequential number auto-assigned for each of order line items in a order, used as an index, for example, \"1\".\n"},"productRatePlanChargeId":{"type":"string","description":"The Id for the associated Product Rate Plan Charge. This field can be null if the Order Line Item is not associated with a Product Rate Plan Charge.\n"},"ratePlanChargeId":{"type":"string","description":"The id for the associated Rate Plan Charge. This field can be null if the metric is generated for an Order Line Item.\n"},"startDate":{"type":"string","format":"date","description":"The start date for the order delta metric.\n"},"subscriptionNumber":{"type":"string","description":"The number of the subscription. This field can be null if the metric is generated for an Order Line Item.\n"},"orderLineItemId":{"type":"string","format":"UUID","description":"The sytem generated Id for the Order Line Item. This field can be null if the metric is generated for subscriptions.\n"}},"description":"Order Delta Tcv. This is a metric that reflects the change to the TCV on Rate Plan Charge object, or the Total Contracted Value for an Order Line Item as the result of the order\n","title":"OrderDeltaTcv"},"PreviewOrderResultOrderDeltaMetrics":{"type":"object","properties":{"orderDeltaMrr":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeltaMrr"}},"orderDeltaTcb":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeltaTcb"}},"orderDeltaTcv":{"type":"array","items":{"$ref":"#/components/schemas/OrderDeltaTcv"}}},"description":"**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).\n","title":"PreviewOrderResultOrderDeltaMetrics"},"OrderItem":{"type":"object","properties":{"endDate":{"type":"string","format":"date","description":"The order item's effective end date, aligned with the end date of an increased quantity order metrics."},"id":{"type":"string","description":"The ID of the order item."},"orderActionId":{"type":"string","description":"Specify the order action that creates this order item."},"quantity":{"type":"number","format":"double","description":"The order item quantity. For the usage charge type, the value of this field is always zero. Also, the Owner Transfer order action always creates an order item whose Quantity field is zero."},"scId":{"type":"string","description":"The ID of the charge segment that gets newly generated when the order item is created."},"startDate":{"type":"string","format":"date","description":"The order item's effective start date, aligned with the start date of an increased quantity order metrics."}},"description":"Represents an order item. An order item is a sales item within an order in the context of the recurring subscription business model. It can be a unit of products or a service, but defined by both quantity and term (the start and end dates). \n\nFor the one time and the recurring charge types, if an order action causes a quantity metric creation (when the delta quantity equals to or is greater than zero), an order item is created.\n\nThe following order actions will create an order item for the one time and recurring charges. The other order actions will refer to an existing order item. Also, the Owner Transfer order action always creates an order item whose quantity field is zero.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Update Product - Increase Quantity\n * Add product\n * Owner Transfer\n\nFor the usage charge type, if the order action causes a usage increase, an order item is created, and the quantity field of the order item is always zero.\n\nThe following order actions will create an order item for for the usage charges.\n\n * Create Subscription\n * Terms and Conditions - Extend Term\n * Renewal\n * Add product\n * Owner Transfer\n","title":"OrderItem"},"TimeSlicedElpNetMetricsGeneratedReason":{"type":"string","enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"description":"Specify the reason why the metrics are generated by the certain order action.\n","title":"TimeSlicedElpNetMetricsGeneratedReason"},"TimeSlicedElpNetMetricsType":{"type":"string","enum":["Regular","Discount"],"description":"The type for ELP is always \"Regular\".","title":"TimeSlicedElpNetMetricsType"},"TimeSlicedElpNetMetrics":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity."},"endDate":{"type":"string","format":"date","description":"The latest date that the metric applies."},"generatedReason":{"$ref":"#/components/schemas/TimeSlicedElpNetMetricsGeneratedReason","description":"Specify the reason why the metrics are generated by the certain order action.\n"},"invoiceOwner":{"type":"string","description":"The acount number of the billing account that is billed for the subscription."},"orderItemId":{"type":"string","description":"The ID of the order item referenced by the order metrics."},"startDate":{"type":"string","format":"date","description":"The earliest date that the metric applies."},"subscriptionOwner":{"type":"string","description":"The acount number of the billing account that owns the subscription."},"tax":{"type":"number","format":"double","description":"The tax amount in the metric when the tax permission is enabled."},"termNumber":{"type":"number","format":"double"},"type":{"$ref":"#/components/schemas/TimeSlicedElpNetMetricsType","description":"The type for ELP is always \"Regular\"."}},"title":"TimeSlicedElpNetMetrics"},"TimeSlicedNetMetricsGeneratedReason":{"type":"string","enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n","title":"TimeSlicedNetMetricsGeneratedReason"},"TimeSlicedNetMetricsType":{"type":"string","enum":["Regular","Discount"],"description":"Indicates whether this metrics is for a regular charge or a discount charge.","title":"TimeSlicedNetMetricsType"},"TimeSlicedNetMetrics":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"discountChargeNumber":{"type":"string"},"endDate":{"type":"string","format":"date"},"generatedReason":{"$ref":"#/components/schemas/TimeSlicedNetMetricsGeneratedReason","description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"invoiceOwner":{"type":"string","description":"The acount number of the billing account that is billed for the subscription."},"orderItemId":{"type":"string","description":"The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"startDate":{"type":"string","format":"date"},"subscriptionOwner":{"type":"string","description":"The acount number of the billing account that owns the subscription."},"termNumber":{"type":"number","format":"double"},"type":{"$ref":"#/components/schemas/TimeSlicedNetMetricsType","description":"Indicates whether this metrics is for a regular charge or a discount charge."}},"title":"TimeSlicedNetMetrics"},"TimeSlicedMetricsGeneratedReason":{"type":"string","enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n","title":"TimeSlicedMetricsGeneratedReason"},"TimeSlicedMetrics":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"endDate":{"type":"string","format":"date"},"generatedReason":{"$ref":"#/components/schemas/TimeSlicedMetricsGeneratedReason","description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"invoiceOwner":{"type":"string","description":"The acount number of the billing account that is billed for the subscription."},"orderItemId":{"type":"string","description":"The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"startDate":{"type":"string","format":"date"},"subscriptionOwner":{"type":"string","description":"The acount number of the billing account that owns the subscription."},"termNumber":{"type":"number","format":"double"}},"title":"TimeSlicedMetrics"},"TimeSlicedTcbNetMetricsGeneratedReason":{"type":"string","enum":["IncreaseQuantity","DecreaseQuantity","ChangePrice","Extension","Contraction"],"description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n","title":"TimeSlicedTcbNetMetricsGeneratedReason"},"TimeSlicedTcbNetMetricsType":{"type":"string","enum":["Regular","Discount"],"description":"Indicates whether this metrics is for a regular charge or a discount charge.","title":"TimeSlicedTcbNetMetricsType"},"TimeSlicedTcbNetMetrics":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"discountChargeNumber":{"type":"string"},"endDate":{"type":"string","format":"date"},"generatedReason":{"$ref":"#/components/schemas/TimeSlicedTcbNetMetricsGeneratedReason","description":"Specify the reason why the metrics are generated by the certain order action.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"invoiceOwner":{"type":"string","description":"The acount number of the billing account that is billed for the subscription."},"orderItemId":{"type":"string","description":"The ID of the order item referenced by the order metrics.\n\nThis field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"startDate":{"type":"string","format":"date"},"subscriptionOwner":{"type":"string","description":"The acount number of the billing account that owns the subscription."},"tax":{"type":"number","format":"double"},"termNumber":{"type":"number","format":"double"},"type":{"$ref":"#/components/schemas/TimeSlicedTcbNetMetricsType","description":"Indicates whether this metrics is for a regular charge or a discount charge."}},"title":"TimeSlicedTcbNetMetrics"},"orderMetric":{"type":"object","properties":{"chargeNumber":{"type":"string"},"elp":{"type":"array","items":{"$ref":"#/components/schemas/TimeSlicedElpNetMetrics"},"description":"The extended list price which is calculated by the original product catalog list price multiplied by the delta quantity.\n\nThe `elp` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"mrr":{"type":"array","items":{"$ref":"#/components/schemas/TimeSlicedNetMetrics"}},"originRatePlanId":{"type":"string"},"productRatePlanChargeId":{"type":"string"},"productRatePlanId":{"type":"string"},"subscriptionRatePlanNumber":{"type":"string","description":"Number of a subscription rate plan for this subscription.\n"},"quantity":{"type":"array","items":{"$ref":"#/components/schemas/TimeSlicedMetrics"}},"tcb":{"type":"array","items":{"$ref":"#/components/schemas/TimeSlicedTcbNetMetrics"},"description":"Total contracted billing which is the forecast value for the total invoice amount."},"tcv":{"type":"array","items":{"$ref":"#/components/schemas/TimeSlicedNetMetrics"},"description":"Total contracted value."}},"description":"The set of order metrics for an order action.","title":"orderMetric"},"PreviewOrderResultOrderMetricsItemsOrderActionsItems":{"type":"object","properties":{"orderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"The `orderItems` nested field is only available to existing Orders customers who already have access to the field.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"orderMetrics":{"type":"array","items":{"$ref":"#/components/schemas/orderMetric"},"description":"The container for order metrics.\n\n**Note:** The following objects and fields of the Order Metrics are end of support. Any new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) or [Orders Harmonization](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Orders_Harmonization/Orders_Harmonization) will not get these metrics.\n* The Order ELP and Order Item objects \n* The \"Generated Reason\" and \"Order Item ID\" fields in the Order MRR, Order TCB, Order TCV, and Order Quantity objects\n\nZuora no longer provides product support, and bug fixes or security issues are no longer addressed.\n"},"sequence":{"type":"string"},"type":{"type":"string"}},"title":"PreviewOrderResultOrderMetricsItemsOrderActionsItems"},"PreviewOrderResultOrderMetricsItems":{"type":"object","properties":{"orderActions":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderResultOrderMetricsItemsOrderActionsItems"}},"subscriptionNumber":{"type":"string"}},"title":"PreviewOrderResultOrderMetricsItems"},"RampIntervalChargeDeltaMetricsDeltaMrrItems":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"The discount delta amount for the MRR."},"endDate":{"type":"string","format":"date","description":"The end date."},"gross":{"type":"number","format":"double","description":"The MRR delta amount before discounts charges are applied."},"net":{"type":"number","format":"double","description":"The MRR delta amount after discounts charges are applied."},"startDate":{"type":"string","format":"date","description":"The start date."}},"title":"RampIntervalChargeDeltaMetricsDeltaMrrItems"},"RampIntervalChargeDeltaMetricsDeltaQuantityItems":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The delta amount of the charge quantity."},"endDate":{"type":"string","format":"date","description":"The end date."},"startDate":{"type":"string","format":"date","description":"The start date."}},"title":"RampIntervalChargeDeltaMetricsDeltaQuantityItems"},"RampIntervalChargeDeltaMetrics":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The number of the rate plan charge."},"deltaDiscountTcb":{"type":"number","format":"double","description":"The discount delta amount for the TCB."},"deltaDiscountTcv":{"type":"number","format":"double","description":"The discount delta amount for the TCV."},"deltaGrossTcb":{"type":"number","format":"double","description":"The TCB delta value before discount charges are applied."},"deltaGrossTcv":{"type":"number","format":"double","description":"The TCV delta value before discount charges are applied."},"deltaMrr":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalChargeDeltaMetricsDeltaMrrItems"},"description":"The MRR changing history of the current rate plan charge in the current ramp interval."},"deltaNetTcb":{"type":"number","format":"double","description":"The TCB delta value after discount charges are applied."},"deltaNetTcv":{"type":"number","format":"double","description":"The TCV delta value after discount charges are applied."},"deltaQuantity":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalChargeDeltaMetricsDeltaQuantityItems"},"description":"The charge quantity changing history of the current rate plan charge in the current ramp interval."},"productRatePlanChargeId":{"type":"string","description":"The ID of the corresponding product rate plan charge."},"subscriptionNumber":{"type":"string","description":"The number of the subscription that the current rate plan charge belongs to."}},"title":"RampIntervalChargeDeltaMetrics"},"RampIntervalChargeMetricsMrrItems":{"type":"object","properties":{"discount":{"type":"number","format":"double","description":"The discount amount for the MRR."},"endDate":{"type":"string","format":"date","description":"The end date."},"gross":{"type":"number","format":"double","description":"The gross MRR amount before discounts charges are applied."},"net":{"type":"number","format":"double","description":"The net MRR amount after discounts charges are applied."},"startDate":{"type":"string","format":"date","description":"The start date."}},"title":"RampIntervalChargeMetricsMrrItems"},"RampIntervalChargeMetrics":{"type":"object","properties":{"chargeNumber":{"type":"string","description":"The number of the charge."},"discountTcb":{"type":"number","format":"double","description":"The discount amount for the TCB."},"discountTcv":{"type":"number","format":"double","description":"The discount amount for the TCV."},"endDate":{"type":"string","format":"date","description":"The end date of the rate plan charge in the current ramp interval."},"grossTcb":{"type":"number","format":"double","description":"The gross TCB value before discount charges are applied."},"grossTcv":{"type":"number","format":"double","description":"The gross TCV value before discount charges are applied."},"mrr":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalChargeMetricsMrrItems"},"description":"The MRR changing history of the current rate plan charge in the current ramp interval."},"netTcb":{"type":"number","format":"double","description":"The net TCB value after discount charges are applied."},"netTcv":{"type":"number","format":"double","description":"The net TCV value after discount charges are applied."},"productRatePlanChargeId":{"type":"string","description":"The ID of the corresponding product rate plan charge."},"quantity":{"type":"number","format":"double","description":"The quantity of the rate plan charge."},"ratePlanChargeId":{"type":"string","description":"The ID of the rate plan charge."},"startDate":{"type":"string","format":"date","description":"The start date of the rate plan charge in the current ramp interval."},"subscriptionNumber":{"type":"string","description":"The number of the subscription that the current rate plan charge belongs to."}},"title":"RampIntervalChargeMetrics"},"OrderRampIntervalMetrics":{"type":"object","properties":{"description":{"type":"string","description":"The short description of the interval."},"discountTcb":{"type":"number","format":"double","description":"The discount amount for the TCB."},"discountTcv":{"type":"number","format":"double","description":"The discount amount for the TCV."},"endDate":{"type":"string","format":"date","description":"The end date of the interval."},"grossTcb":{"type":"number","format":"double","description":"The gross TCB value before discount charges are applied."},"grossTcv":{"type":"number","format":"double","description":"The gross TCV value before discount charges are applied."},"intervalDeltaMetrics":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalChargeDeltaMetrics"},"description":"Container for the delta metrics for each rate plan charge in each ramp interval. The delta is the difference of the subscription metrics between before and after the order."},"intervalMetrics":{"type":"array","items":{"$ref":"#/components/schemas/RampIntervalChargeMetrics"},"description":"Container for the detailed metrics for each rate plan charge in each ramp interval."},"name":{"type":"string","description":"The name of the interval."},"netTcb":{"type":"number","format":"double","description":"The net TCB value after discount charges are applied."},"netTcv":{"type":"number","format":"double","description":"The net TCV value after discount charges are applied."},"startDate":{"type":"string","format":"date","description":"The start date of the interval."}},"title":"OrderRampIntervalMetrics"},"OrderRampMetrics":{"type":"object","properties":{"description":{"type":"string","description":"The short description of the ramp."},"discountTcb":{"type":"number","format":"double","description":"The discount amount for the TCB."},"discountTcv":{"type":"number","format":"double","description":"The discount amount for the TCV."},"grossTcb":{"type":"number","format":"double","description":"The gross TCB value before discount charges are applied."},"grossTcv":{"type":"number","format":"double","description":"The gross TCV value before discount charges are applied."},"intervals":{"type":"array","items":{"$ref":"#/components/schemas/OrderRampIntervalMetrics"},"description":"The ramp metrics for each ramp intervals in its timeline."},"name":{"type":"string","description":"The name of the ramp."},"netTcb":{"type":"number","format":"double","description":"The net TCB value after discount charges are applied."},"netTcv":{"type":"number","format":"double","description":"The net TCV value after discount charges are applied."},"number":{"type":"string","description":"The number of the ramp. It is automaticcally generated by the billing system."}},"title":"OrderRampMetrics"},"PreviewOrderResult":{"type":"object","properties":{"chargeMetrics":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderResultChargeMetricsItems"}},"creditMemos":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderResultCreditMemosItems"},"description":"This field is only available if you have the Invoice Settlement feature enabled."},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderResultInvoicesItems"}},"orderDeltaMetrics":{"$ref":"#/components/schemas/PreviewOrderResultOrderDeltaMetrics","description":"**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr)\n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv)\n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb)\n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/).\n"},"orderMetrics":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderResultOrderMetricsItems"},"description":"**Note:** As of Zuora Billing Release 306, Zuora has upgraded the methodologies for calculating metrics in [Orders](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders). The new methodologies are reflected in the following Order Delta Metrics objects. \n* [Order Delta Mrr](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Mrr) \n* [Order Delta Tcv](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcv) \n* [Order Delta Tcb](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/Order_Delta_Tcb) \n\nIt is recommended that all customers use the new [Order Delta Metrics](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Delta_Metrics/AA_Overview_of_Order_Delta_Metrics). If you are an existing [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders) customer and want to migrate to Order Delta Metrics, submit a request at [Zuora Global Support](https://support.zuora.com/). \n\nWhereas new customers, and existing customers not currently on [Order Metrics](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders/Key_Metrics_for_Orders), will no longer have access to Order Metrics, existing customers currently using Order Metrics will continue to be supported.\n"},"rampMetrics":{"type":"array","items":{"$ref":"#/components/schemas/OrderRampMetrics"},"description":"**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020.\n\nThe ramp metrics.\n"}},"description":"The result of each type of preview. Returned only when the current request is preview call.","title":"PreviewOrderResult"},"PostOrderPreviewResponseType":{"type":"object","properties":{"processId":{"type":"string","description":"The ID of the process that handles the operation.\n"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderPreviewResponseTypeReasonsItems"},"description":"The container of the error code and message. This field is available only if the `success` field is `false`.\n"},"requestId":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"Unique identifier of the request.\n"},"success":{"type":"boolean","description":"Indicates whether the call succeeded.\n"},"previewResult":{"$ref":"#/components/schemas/PreviewOrderResult"}},"title":"PostOrderPreviewResponseType"},"PostOrderPreviewAsyncRequestTypeCategory":{"type":"string","enum":["NewSales","Return"],"default":"NewSales","description":"Category of the order to indicate a product sale or return. Default value is `NewSales`.\n","title":"PostOrderPreviewAsyncRequestTypeCategory"},"PostOrderPreviewAsyncRequestTypeSubscriptionsItems":{"type":"object","properties":{"customFields":{"$ref":"#/components/schemas/SubscriptionObjectCustomFields"},"notes":{"type":"string","maxLength":1000,"description":"Notes about the subscription. These notes are only visible to Zuora users. Notes set in this field will override the value of the `notes` field within the createSubscription order action.\n"},"orderActions":{"type":"array","items":{"$ref":"#/components/schemas/PreviewOrderOrderAction"},"description":"The actions to be applied to the subscription. Order actions will be stored with the sequence when it was provided in the request."},"quote":{"$ref":"#/components/schemas/QuoteObjectFields"},"ramp":{"$ref":"#/components/schemas/RampRequest"},"subscriptionNumber":{"type":"string","description":"Leave this field empty to represent new subscription creation, or specify a subscription number to update an existing subscription.\n"}},"title":"PostOrderPreviewAsyncRequestTypeSubscriptionsItems"},"POSTOrderPreviewAsyncRequestType":{"type":"object","properties":{"category":{"$ref":"#/components/schemas/PostOrderPreviewAsyncRequestTypeCategory","default":"NewSales","description":"Category of the order to indicate a product sale or return. Default value is `NewSales`.\n"},"customFields":{"$ref":"#/components/schemas/OrderObjectCustomFields"},"description":{"type":"string","maxLength":500,"description":"A description of the order."},"existingAccountId":{"type":"string","description":"The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field. \n\n**Note:** You can specify either the `existingAccountNumber` or `existingAccountId` field, but not both.\n"},"existingAccountNumber":{"type":"string","maxLength":70,"description":"The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the `subscriptionOwnerAccountNumber` and `invoiceOwnerAccountNumber` nested fields in the `subscriptions` field.\n"},"orderDate":{"type":"string","format":"date","description":"The date when the order is signed. All of the order actions under this order will use this order date as the contract effective date."},"orderLineItems":{"type":"array","items":{"$ref":"#/components/schemas/CreateOrderOrderLineItem"},"description":"[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\nIf you do not have the **Create Order Line Items Without Product Catalog** billing permission, you can only create order line items from existing products by specifying the product rate plan charge ID in the `productRatePlanChargeId` field. For more information about billing permissions, see Billing Roles.\n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default. \n"},"orderNumber":{"type":"string","maxLength":100,"description":"The order number of this order. \n**Note:** The characters `#`, `?`, and `/` are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: `_`,`-`, `.`, `~`, `*`, `(`, `)`, and `'`.\n"},"previewAccountInfo":{"$ref":"#/components/schemas/PreviewAccountInfo"},"previewOptions":{"$ref":"#/components/schemas/PreviewOptions"},"reasonCode":{"type":"string","maxLength":255,"description":"Values of reason code configured in **Billing Settings** > **Configure Reason Codes** through Zuora UI. Indicates the reason when a return order line item occurs.\n"},"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderPreviewAsyncRequestTypeSubscriptionsItems"},"description":"Each item includes a set of order actions, which will be applied to the same base subscription. When you create an order that involves multiple subscriptions, these subscriptions can have different invoice owner accounts or subscription owner accounts. "}},"required":["orderDate","previewOptions"],"title":"POSTOrderPreviewAsyncRequestType"},"Orders_POST_PreviewOrderAsynchronously_Response_202":{"type":"object","properties":{"jobId":{"type":"string","format":"UUID","description":"The ID of an asynchronous job that will be returned for tracking the status and result of the job."}},"title":"Orders_POST_PreviewOrderAsynchronously_Response_202"},"V1OrdersGetParametersStatus":{"type":"string","enum":["all","cancelled","completed","draft","executing","failed","pending","scheduled"],"title":"V1OrdersGetParametersStatus"},"OrderCategory":{"type":"string","enum":["NewSales","Return"],"default":"NewSales","description":"Category of the order to indicate a product sale or return. Default value is `NewSales`.\n","title":"OrderCategory"},"CommitmentTypeEnum":{"type":"string","enum":["MinCommitment","MaxCommitment"],"description":"The type of the commitment.\n","title":"CommitmentTypeEnum"},"CommitmentPrepaymentTypeEnum":{"type":"string","enum":["NotPrepaid","FullyPrepaid"],"description":"The prepayment type of the commitment.","title":"CommitmentPrepaymentTypeEnum"},"PeriodAlignmentOptionEnum":{"type":"string","enum":["CommitmentStartDate","SpecificDate"],"default":"CommitmentStartDate","description":"Options for aligning the commitment periods within a commitment.\n","title":"PeriodAlignmentOptionEnum"},"ActionType":{"type":"string","enum":["create","update","cancel"],"description":"The action type of the commitment.\n","title":"ActionType"},"AmountBaseEnum":{"type":"string","enum":["CommitmentPeriod"],"default":"CommitmentPeriod","description":"The level for which the committed amount applies to.","title":"AmountBaseEnum"},"PeriodTypeEnum":{"type":"string","enum":["Month","Quarter","SemiAnnual","Year","SpecificMonths","SinglePeriod"],"default":"Month","description":"The frequency type of the period of the commitment schedule.\n","title":"PeriodTypeEnum"},"PrepaymentFrequencyEnum":{"type":"string","enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Week","Specific_Weeks","Specific_Days"],"description":"The prepayment frequency for the prepayment definition. If the value is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`, use the `specificFrequency` field to specify the duration.\n","title":"PrepaymentFrequencyEnum"},"PrepaymentDefinition":{"type":"object","properties":{"prepaymentFrequency":{"$ref":"#/components/schemas/PrepaymentFrequencyEnum"},"specificFrequency":{"type":"integer","description":"The specific frequency length. This field is required when `prepaymentFrequency` is `Specific_Months`, `Specific_Weeks`, or `Specific_Days`."},"customFields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Container for custom fields of a prepayment definition object."}},"description":"The prepayment definition for the commitment schedule.","title":"PrepaymentDefinition"},"GetCommitmentOutputListOrdersSchedulesItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the schedule."},"startDate":{"type":"string","description":"The start date of the schedule."},"endDate":{"type":"string","description":"The end date of the schedule."},"totalAmount":{"type":"number","format":"double","description":"The total amount of the schedule."},"action":{"$ref":"#/components/schemas/ActionType"},"amountBase":{"$ref":"#/components/schemas/AmountBaseEnum","default":"CommitmentPeriod"},"periodType":{"$ref":"#/components/schemas/PeriodTypeEnum","default":"Month"},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"},"specificPeriodLength":{"type":"integer","description":"The specific period length of each period in the schedule."}},"title":"GetCommitmentOutputListOrdersSchedulesItems"},"GetCommitmentOutputListOrdersTaxMode":{"type":"string","enum":["TaxInclusive","TaxExclusive"],"description":"The tax mode of a charge. This field is available when the `taxable` field is set to `true`.\n","title":"GetCommitmentOutputListOrdersTaxMode"},"EligibleAccountConditionOperator":{"type":"string","enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"],"description":"The operator of a single condition.\n\nExample: \n\n - eq: equal, field = value \n - neq: not equal, field != value \n - gt: greater than, field > value \n - lt: less than, field < value \n - gte: greater than or equal, field >= value \n - lte: less than or equal, field <= value - lk: like, field like value \n - in: in, field in value, multiple values are separated by commas \n - nl: null, field is null \n - nnl: not null, field is not null\n","title":"EligibleAccountConditionOperator"},"EligibleAccountConditionRelation":{"type":"string","enum":["and","or"],"description":"The relation among the conditions.\n","title":"EligibleAccountConditionRelation"},"EligibleAccountCondition":{"type":"object","properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"$ref":"#/components/schemas/EligibleAccountConditionOperator","description":"The operator of a single condition.\n\nExample: \n\n - eq: equal, field = value \n - neq: not equal, field != value \n - gt: greater than, field > value \n - lt: less than, field < value \n - gte: greater than or equal, field >= value \n - lte: less than or equal, field <= value - lk: like, field like value \n - in: in, field in value, multiple values are separated by commas \n - nl: null, field is null \n - nnl: not null, field is not null\n"},"value":{"type":"string","description":"The value of a single condition, which can be a list of values separated by commas.\n\n\n**Notes:** Account Condition only contains account related fields. Support is provided only for the indexed custom fields.\n"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/EligibleAccountCondition"},"description":"The conditions will be combined by the relation.\n"},"relation":{"$ref":"#/components/schemas/EligibleAccountConditionRelation","description":"The relation among the conditions.\n"}},"description":"The conditions for account level filters for the commitment.","title":"EligibleAccountCondition"},"EligibleChargeConditionOperator":{"type":"string","enum":["eq","neq","gt","lt","gte","lte","lk","in","nl","nnl"],"description":"The operator of a single condition.\n\nExample: \n \n - eq: equal, field = value \n - neq: not equal, field != value \n - gt: greater than, field > value \n - lt: less than, field < value \n - gte: greater than or equal, field >= value \n - lte: less than or equal, field <= value \n - lk: like, field like value \n - in: in, field in value, multiple values are separated by commas \n - nl: null, field is null \n - nnl: not null, field is not null\n","title":"EligibleChargeConditionOperator"},"EligibleChargeConditionRelation":{"type":"string","enum":["and","or"],"description":"The relation among the conditions.\n","title":"EligibleChargeConditionRelation"},"EligibleChargeCondition":{"type":"object","properties":{"field":{"type":"string","description":"The field name of a single condition.\n"},"operator":{"$ref":"#/components/schemas/EligibleChargeConditionOperator","description":"The operator of a single condition.\n\nExample: \n \n - eq: equal, field = value \n - neq: not equal, field != value \n - gt: greater than, field > value \n - lt: less than, field < value \n - gte: greater than or equal, field >= value \n - lte: less than or equal, field <= value \n - lk: like, field like value \n - in: in, field in value, multiple values are separated by commas \n - nl: null, field is null \n - nnl: not null, field is not null\n"},"value":{"type":"string","description":"The value of a single condition, which can be a list of values separated by commas.\n\n\n**Notes:** \n- PPDD (PrePaid DrawDown) charge will not be loaded during evaluation. \n- Charge condition only contains charge related fields. Support is provided only for the indexed custom fields.\n- Charge types supports only the OneTime, Recurring and Usage values. \n- Charge models supports only the FlatFee, PerUnit, Overage, Volume Tiered, TieredWithOverage, and Calculated values. \n"},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/EligibleChargeCondition"},"description":"The conditions will be combined by the relation.\n"},"relation":{"$ref":"#/components/schemas/EligibleChargeConditionRelation","description":"The relation among the conditions.\n"}},"description":"The conditions for charge level filters for the commitment.","title":"EligibleChargeCondition"},"CommitmentSettlementType":{"type":"string","enum":["NoSettlement","FullMinimum","CurrentPeriodOnly"],"description":"Settlement type for commitment cancellation.\n\n- `NoSettlement` - No settlement\n- `FullMinimum` - Full minimum due (evaluate the commitment until the commitment end)\n- `CurrentPeriodOnly` - Period minimum due (evaluate the commitment through the cancellation period end)\n","title":"CommitmentSettlementType"},"CommitmentCancellationPolicy":{"type":"object","properties":{"settlementType":{"$ref":"#/components/schemas/CommitmentSettlementType"}},"description":"Cancellation policy for a commitment. Defines how settlements are handled when a commitment is cancelled.","title":"CommitmentCancellationPolicy"},"GetCommitmentOutputListOrdersStatus":{"type":"string","enum":["Cancel1ed","Active","Evaluated","CancelledPendingEvaluation"],"description":"The status of the commitment.","title":"GetCommitmentOutputListOrdersStatus"},"GetCommitmentOutputListOrders":{"type":"object","properties":{"commitmentNumber":{"type":"string","maxLength":100,"description":"The commitment number.\n"},"id":{"type":"string","description":"ID of the commitment.\n"},"name":{"type":"string","maxLength":255,"description":"The name of the commitment. \n"},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"description":{"type":"string","maxLength":500,"description":"The description of the commitment. \n"},"prepaymentType":{"$ref":"#/components/schemas/CommitmentPrepaymentTypeEnum"},"priority":{"type":"integer","description":"It defines the evaluation order of the commitment. The lower the number, the higher the priority.\nWhen two commitments have the same priority, the commitment that was created initially will be evaluated first.\n"},"customFields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Container for custom fields of a Commitment object."},"specificPeriodAlignmentDate":{"type":"string","format":"date","description":"The specific date for the period alignment. This field is required only if the `periodAlignmentOption` is set to `SpecificDate`."},"periodAlignmentOption":{"$ref":"#/components/schemas/PeriodAlignmentOptionEnum","default":"CommitmentStartDate"},"schedules":{"type":"array","items":{"$ref":"#/components/schemas/GetCommitmentOutputListOrdersSchedulesItems"},"description":"A list of Commitment schedule objects.\n"},"accountReceivableAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the Commitment object for customers. \n"},"adjustmentLiabilityAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the commitment for customers.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled. \n"},"adjustmentRevenueAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the commitment for customers.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled. \n"},"contractAssetAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the commitment for customers.\n\n\n**Notes:** This field is only available if you have the Order to Revenue feature enabled. \n"},"contractLiabilityAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the commitment for customers.\n\n\n**Notes:** This field is only available if you have the Order to Revenue feature enabled. \n"},"contractRecognizedRevenueAccountingCode":{"description":"The accounting code on the commitment for customers.\n\n\n**Notes:** This field is only available if you have the Order to Revenue feature enabled. \n"},"deferredRevenueAccountingCode":{"type":"string","maxLength":100,"description":"The deferred revenue accounting code for the commitment.\n"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":"The flag to exclude commitment related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled. \n"},"isAllocationEligible":{"type":"boolean","description":"This field is used to identify if the commitment is allocation eligible in revenue recognition.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled. \n"},"isUnbilled":{"type":"boolean","description":"This field is used to dictate how to perform the accounting during revenue recognition.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled.\n"},"recognizedRevenueAccountingCode":{"type":"string","maxLength":100,"description":"The recognized revenue accounting code for the commitment.\n"},"revenueAmortizationMethod":{"type":"string","maxLength":200,"description":"This field is used to dictate the type of revenue amortization method.\n"},"revenueRecognitionRule":{"type":"string","maxLength":255,"description":"The revenue recognition rule for the commitment.\n"},"revenueRecognitionTiming":{"type":"string","maxLength":200,"description":"This field is used to dictate the type of revenue recognition timing.\n"},"unbilledReceivablesAccountingCode":{"type":"string","maxLength":100,"description":"The accounting code on the commitment for customers.\n\n\n**Note:** This field is only available if you have the Order to Revenue feature enabled. \n"},"taxable":{"type":"boolean","description":"The flag to indicate whether the charge is taxable. If this field is set to `true`, both the fields `taxCode` and `taxMode` are required.\n"},"taxCode":{"type":"string","maxLength":100,"description":"The tax code of a charge.\n\n\n**Note:** This field is available when the `taxable` field is set to `true`.\n"},"taxMode":{"$ref":"#/components/schemas/GetCommitmentOutputListOrdersTaxMode","description":"The tax mode of a charge. This field is available when the `taxable` field is set to `true`.\n"},"version":{"type":"integer","description":"Version of the commitment.\n"},"currency":{"type":"string","description":"Currency of the commitment.\n"},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","default":true,"description":"The flag to exclude Commitment period from revenue accounting."},"eligibleAccountConditions":{"$ref":"#/components/schemas/EligibleAccountCondition"},"eligibleChargeConditions":{"$ref":"#/components/schemas/EligibleChargeCondition"},"cancellationEffectiveDate":{"type":"string","format":"date","description":"The date when the cancellation takes effect.\n"},"cancellationPolicyOverride":{"$ref":"#/components/schemas/CommitmentCancellationPolicy"},"status":{"$ref":"#/components/schemas/GetCommitmentOutputListOrdersStatus","description":"The status of the commitment."},"action":{"$ref":"#/components/schemas/ActionType"}},"title":"GetCommitmentOutputListOrders"},"OrderExistingAccountDetails":{"type":"object","properties":{"basicInfo":{"$ref":"#/components/schemas/GETAccountTypeBasicInfo"},"billToContact":{"$ref":"#/components/schemas/GETAccountTypeBillToContact"}},"description":"The account basic information that this order has been created under.\n","title":"OrderExistingAccountDetails"},"OrderLineItemRetrieveOrderBillingRule":{"type":"string","enum":["TriggerWithoutFulfillment","TriggerAsFulfillmentOccurs"],"description":"The billing rule of the Order Line Item.\n","title":"OrderLineItemRetrieveOrderBillingRule"},"OrderLineItemRetrieveOrderInlineDiscountType":{"type":"string","enum":["Percentage","FixedAmount","None"],"description":"This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n","title":"OrderLineItemRetrieveOrderInlineDiscountType"},"OrderLineItemRetrieveOrderItemCategory":{"type":"string","enum":["Sales","Return"],"default":"Sales","description":"The category of the Order Line Item, to indicate a product sale or return.\n","title":"OrderLineItemRetrieveOrderItemCategory"},"OrderLineItemRetrieveOrderItemState":{"type":"string","enum":["Executing","Booked","SentToBilling","Complete","Cancelled"],"description":"The state of an Order Line Item. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n","title":"OrderLineItemRetrieveOrderItemState"},"OrderLineItemRetrieveOrderItemType":{"type":"string","enum":["Product","Fee","Services"],"description":"The type of the Order Line Item. \n","title":"OrderLineItemRetrieveOrderItemType"},"OrderLineItemRetrieveOrderRevenueRecognitionTiming":{"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"],"description":"Specifies the type of revenue recognition timing.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n","title":"OrderLineItemRetrieveOrderRevenueRecognitionTiming"},"OrderLineItemRetrieveOrderRevenueAmortizationMethod":{"type":"string","enum":["Immediate","Ratable Using Start And End Dates"],"description":"Specifies the type of revenue amortization method.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n","title":"OrderLineItemRetrieveOrderRevenueAmortizationMethod"},"OrderLineItemRetrieveOrderTaxMode":{"type":"string","enum":["TaxInclusive","TaxExclusive"],"description":"The tax mode for the Order Line Item.\n","title":"OrderLineItemRetrieveOrderTaxMode"},"OrderLineItemRetrieveOrder":{"type":"object","properties":{"amendedByOrderOn":{"type":"string","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.\n"},"amount":{"type":"number","format":"double","description":"The calculated gross amount for the Order Line Item.\n"},"amountWithoutTax":{"type":"number","format":"double","description":"The calculated gross amount for an order line item excluding tax. If the tax mode is tax exclusive, the value of this field equals that of the `amount` field.\n\nIf the tax mode of an order line item is not set, the system treats it as tax exclusive by default. The value of the `amountWithoutTax` field equals that of the `amount` field.\n\nIf you create an order line item from the product catalog, the tax mode and tax code of the product rate plan charge are used for the order line item by default. You can still overwrite this default set-up by setting the tax mode and tax code of the order line item.\n"},"id":{"type":"string","format":"UUID","description":"The sytem generated Id for the Order Line Item.\n"},"invoiceGroupNumber":{"type":["string","null"],"description":"The number of the invoice group associated with the order line item. \n\nThe value of this field is `null` if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.\n"},"sequenceSetId":{"type":["string","null"],"description":"The ID of the sequence set associated with the OrderLineItem.\n"},"communicationProfileId":{"type":["string","null"],"description":"The ID of the communication profile associated with the order line item.\n\n**Note**: This field is available in the request body only if you have the Flexible Billing Attributes\nfeature turned on. The value is `null` in the response body without this feature turned on.\n"},"paymentTerm":{"type":"string","description":"The payment term name associated with the order line item.\n\nThe value of this field is `null` if you have the [Flexible Billing\nAttributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)\nfeature disabled.\n"},"invoiceTemplateId":{"type":"string","description":"The ID of the invoice template associated with the order line item.\n\nThe value of this field is `null` if you have the [Flexible Billing\nAttributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes)\nfeature disabled.\n"},"itemNumber":{"type":"string","description":"The number for the Order Line Item.\n"},"originalOrderDate":{"type":"string","format":"date","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.\n"},"quantityFulfilled":{"type":"number","format":"double","description":"The fulfilled quantity for an order line item.\n"},"quantityPendingFulfillment":{"type":"number","format":"double","description":"The quantity to fulfill for an order line item. \n"},"UOM":{"type":"string","description":"Specifies the units to measure usage.\n"},"accountingCode":{"type":"string","description":"The accounting code for the Order Line Item.\n"},"adjustmentLiabilityAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"},"adjustmentRevenueAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"},"amountPerUnit":{"type":"number","format":"double","description":"The actual charged amount per unit for the Order Line Item.\n"},"billTargetDate":{"type":"string","format":"date","description":"The target date for the Order Line Item to be picked up by bill run for billing.\n"},"billTo":{"type":"string","description":"The ID of the bill-to contact of an order line item. An existing contact under the billing account is specified as the bill-to contact of the order line item. The billing account is the order account.\n"},"billToSnapshotId":{"type":"string","description":"The snapshot of the ID for an account used as the bill-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `billToSnapshotId` field is exposed while retrieving the order line item details.\n"},"billingRule":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderBillingRule","description":"The billing rule of the Order Line Item.\n"},"contractAssetAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"},"contractLiabilityAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"},"contractRecognizedRevenueAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"},"currency":{"type":"string","description":"The currency for the order line item. You can specify a currency when creating an order line item through the \"Create an order\" operation.\n"},"customFields":{"$ref":"#/components/schemas/OrderLineItemCustomFields"},"deferredRevenueAccountingCode":{"type":"string","description":"The deferred revenue accounting code for the Order Line Item.\n"},"description":{"type":"string","description":"The description of the Order Line Item.\n"},"discount":{"type":"number","format":"double","description":"This field shows the total discount amount that is applied to an order line item after the `inlineDiscountType`, `inlineDiscountPerUnit` and `quantity` fields are set.\n\nThe inline discount is applied to the list price of an order line item (see the `listPrice` field).\n"},"excludeItemBillingFromRevenueAccounting":{"type":"boolean","description":"The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"},"excludeItemBookingFromRevenueAccounting":{"type":"boolean","description":"The flag to exclude Order Line Item from revenue accounting.\n\n**Note**: This field is only available if you have the Order to Revenue or [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration) feature enabled. \n"},"inlineDiscountPerUnit":{"type":"number","format":"double","description":"This field is used in accordance with the `inlineDiscountType` field, in the following manner:\n* If the `inlineDiscountType` field is set as `Percentage`, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify `5` in this field, the discount percentage is 5%.\n* If the `inlineDiscountType` field is set as `FixedAmount`, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify `10` in this field, the discount amount on each unit of the order line item is 10.\n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"},"inlineDiscountType":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderInlineDiscountType","description":"This field is used to specify the inline discount type, which can be `Percentage`, `FixedAmount`, or `None`. The default value is `Percentage`.\n\nThis field is used together with the `inlineDiscountPerUnit` field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. \n\nOnce you set the `inlineDiscountType`, `inlineDiscountPerUnit`, and `listPricePerUnit` fields, the system will automatically generate the `amountPerUnit` field. You shall not set the `amountPerUnit` field by yourself.\n"},"invoiceOwnerAccountId":{"type":"string","description":"The account ID of the invoice owner of the order line item.\n"},"invoiceOwnerAccountName":{"type":"string","description":"The account name of the invoice owner of the order line item.\n"},"invoiceOwnerAccountNumber":{"type":"string","description":"The account number of the invoice owner of the order line item.\n"},"isAllocationEligible":{"type":"boolean","description":"This field is used to identify if the charge segment is allocation\neligible in revenue recognition.\n\n\n**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.\n"},"isUnbilled":{"type":"boolean","description":"This field is used to dictate how to perform the accounting during revenue\nrecognition.\n\n\n**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.\n"},"itemCategory":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderItemCategory","default":"Sales","description":"The category of the Order Line Item, to indicate a product sale or return.\n"},"itemName":{"type":"string","description":"The name of the Order Line Item.\n"},"itemState":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderItemState","description":"The state of an Order Line Item. See [State transitions for an order, order line item, and fulfillment](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AB_Order_Line_Item_States_and_Order_States) for more information.\n"},"itemType":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderItemType","description":"The type of the Order Line Item. \n"},"listPrice":{"type":"number","format":"double","description":"The extended list price for an order line item, calculated by the formula: listPrice = listPricePerUnit * quantity\n"},"listPricePerUnit":{"type":"number","format":"double","description":"The list price per unit for the Order Line Item.\n"},"originalOrderId":{"type":"string","description":"The ID of the original sale order for a return order line item. \n"},"originalOrderLineItemId":{"type":"string","description":"The ID of the original sale order line item for a return order line item. \n"},"originalOrderLineItemNumber":{"type":"string","description":"The number of the original sale order line item for a return order line item. \n"},"originalOrderNumber":{"type":"string","description":"The number of the original sale order for a return order line item. \n"},"ownerAccountId":{"type":"string","description":"The account ID of the owner of the order line item.\n"},"ownerAccountName":{"type":"string","description":"The account name of the owner of the order line item.\n"},"ownerAccountNumber":{"type":"string","description":"The account number of the owner of the order line item.\n"},"productCode":{"type":"string","description":"The product code for the Order Line Item.\n"},"productRatePlanChargeId":{"type":"string","description":"Id of a Product Rate Plan Charge. Only one-time charges are supported.\n"},"purchaseOrderNumber":{"type":"string","description":"Used by customers to specify the Purchase Order Number provided by the buyer.\n"},"quantity":{"type":"number","format":"double","description":"The quantity of units, such as the number of authors in a hosted wiki service.\n"},"quantityAvailableForReturn":{"type":"number","format":"double","description":"The quantity that can be returned for an order line item. \n"},"recognizedRevenueAccountingCode":{"type":"string","description":"The recognized revenue accounting code for the Order Line Item.\n"},"relatedSubscriptionNumber":{"type":"string","description":"Use this field to relate an order line item to a subscription when you create the order line item.\n\n* To relate an order line item to a new subscription which is yet to create in the same \"Create an order\" call, use this field in combination with the `subscriptions` > `subscriptionNumber` field in the \"Create order\" operation. Specify this field to the same value as that of the 'subscriptions' > `subscriptionNumber` field when you make the \"Create order\" call.\n* To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription.\n"},"requiresFulfillment":{"type":"boolean","description":"The flag to show whether fulfillment is needed or not. It's derived from billing rule of the Order Line Item.\n"},"revenueRecognitionRule":{"type":"string","description":"The Revenue Recognition rule for the Order Line Item.\n"},"revenueRecognitionTiming":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderRevenueRecognitionTiming","description":"Specifies the type of revenue recognition timing.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"},"revenueAmortizationMethod":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderRevenueAmortizationMethod","description":"Specifies the type of revenue amortization method.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n"},"shipTo":{"type":"string","description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the ship-to contact of an order line item. The billing account is the order account.\n"},"shipToSnapshotId":{"type":"string","description":"The snapshot of the ID for an account used as the ship-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `shipToSnapshotId` field is exposed while retrieving the order line item details.\n"},"soldTo":{"type":"string","description":"The ID of a contact that belongs to the owner acount or billing account of the order line item. Use this field to assign an existing account as the sold-to contact of an order line item. The billing account is the order account.\n"},"soldToSnapshotId":{"type":"string","description":"The snapshot of the ID for an account used as the sold-to contact of an order line item. This field is used to store the original information about the account, in case the information about the account is changed after the creation of the order line item. The `soldToSnapshotId` field is exposed while retrieving the order line item details.\n"},"taxCode":{"type":"string","description":"The tax code for the Order Line Item.\n"},"taxMode":{"$ref":"#/components/schemas/OrderLineItemRetrieveOrderTaxMode","description":"The tax mode for the Order Line Item.\n"},"transactionEndDate":{"type":"string","format":"date","description":"The date a transaction is completed. The default value of this field is the transaction start date. Also, the value of this field should always equal or be later than the value of the `transactionStartDate` field.\n"},"transactionStartDate":{"type":"string","format":"date","description":"The date a transaction starts. The default value of this field is the order date.\n"},"unbilledReceivablesAccountingCode":{"type":"string","description":"The accounting code on the Order Line Item object for customers using [Zuora Billing - Revenue Integration](https://knowledgecenter.zuora.com/Zuora_Revenue/Zuora_Billing_-_Revenue_Integration).\n"}},"title":"OrderLineItemRetrieveOrder"},"OrderSchedulingOptionsScheduledDatePolicy":{"type":"string","enum":["SpecificDate"],"description":"Date policy of the scheduled order.","title":"OrderSchedulingOptionsScheduledDatePolicy"},"OrderSchedulingOptions":{"type":"object","properties":{"scheduledDate":{"type":"string","format":"date","description":"The date for the order scheduled.\n"},"scheduledDatePolicy":{"$ref":"#/components/schemas/OrderSchedulingOptionsScheduledDatePolicy","description":"Date policy of the scheduled order."}},"description":"Information of scheduled order.\n","title":"OrderSchedulingOptions"},"PostOrderResponseTypeReasonsItems":{"type":"object","properties":{"code":{"type":"string","description":"The error code of response.\n"},"message":{"type":"string","description":"The detail information of the error response\n"}},"title":"PostOrderResponseTypeReasonsItems"},"CommitmentOutputStatus":{"type":"string","enum":["Cancel1ed","Active","Evaluated","CancelledPendingEvaluation"],"description":"The status of the commitment.","title":"CommitmentOutputStatus"},"CommitmentOutputSchedulesItemsStatus":{"type":"string","enum":["Active","Evaluated","Cancelled","CancelledPendingEvaluation"],"description":"The status of the schedule.","title":"CommitmentOutputSchedulesItemsStatus"},"CommitmentOutputSchedulesItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the schedule."},"startDate":{"type":"string","description":"The start date of the schedule."},"endDate":{"type":"string","description":"The end date of the schedule."},"prepaymentDefinition":{"$ref":"#/components/schemas/PrepaymentDefinition"},"totalAmount":{"type":"number","format":"double","description":"The total amount of the schedule."},"status":{"$ref":"#/components/schemas/CommitmentOutputSchedulesItemsStatus","description":"The status of the schedule."}},"title":"CommitmentOutputSchedulesItems"},"CommitmentOutput":{"type":"object","properties":{"id":{"type":"string","description":"ID of the commitment\n"},"commitmentNumber":{"type":"string","description":"Number of the commitment.\n"},"prepaymentType":{"$ref":"#/components/schemas/CommitmentPrepaymentTypeEnum"},"type":{"$ref":"#/components/schemas/CommitmentTypeEnum"},"startDate":{"type":"string","format":"date","description":"The start date of the commitment.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the commitment.\n"},"status":{"$ref":"#/components/schemas/CommitmentOutputStatus","description":"The status of the commitment."},"totalAmount":{"type":"number","format":"double","description":"The total amount of the commitment."},"schedules":{"type":"array","items":{"$ref":"#/components/schemas/CommitmentOutputSchedulesItems"},"description":"A list of Commitment schedule objects.\n"}},"description":"The Commitment object in the \"Create an order\" or \"Update an order\" response.\n","title":"CommitmentOutput"},"PostOrderResponseTypeOrderLineItemsItems":{"type":"object","properties":{"id":{"type":"string","maxLength":32,"description":"The sytem generated Id for the Order Line Item."},"itemNumber":{"type":"string","maxLength":100,"description":"The number for the Order Line Item."}},"title":"PostOrderResponseTypeOrderLineItemsItems"},"PostOrderResponseTypeRampsItems":{"type":"object","properties":{"rampNumber":{"type":"string","maxLength":50,"description":"The number of the ramp definition."},"subscriptionNumber":{"type":"string","maxLength":150,"description":"The number of the subscription that this ramp deal definition is applied to."}},"title":"PostOrderResponseTypeRampsItems"},"PostOrderResponseTypeRefundsItemsStatus":{"type":"string","enum":["Success","Error"],"description":"The status of the refund.","title":"PostOrderResponseTypeRefundsItemsStatus"},"PostOrderResponseTypeRefundsItems":{"type":"object","properties":{"number":{"type":"string","maxLength":32,"description":"The refund number."},"refundInvoiceNumbers":{"type":"array","items":{"type":"string","maxLength":255},"description":"An array of the refunded invoice numbers generated in this order request."},"status":{"$ref":"#/components/schemas/PostOrderResponseTypeRefundsItemsStatus","description":"The status of the refund."}},"title":"PostOrderResponseTypeRefundsItems"},"PostOrderResponseTypeStatus":{"type":"string","enum":["Draft","Pending","Completed","Scheduled"],"description":"Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action.","title":"PostOrderResponseTypeStatus"},"PostOrderResponseTypeWriteOffItemsStatus":{"type":"string","enum":["Success","Failed"],"description":"The status of the write-off.","title":"PostOrderResponseTypeWriteOffItemsStatus"},"PostOrderResponseTypeWriteOffItems":{"type":"object","properties":{"amount":{"type":"number","format":"double","minimum":9,"maximum":22,"description":"The amount written off from the invoice balance."},"failedReason":{"type":"string","description":"The reason of write-off failure."},"invoiceNumber":{"type":"string","maxLength":255,"description":"The number of the invoice that is written off."},"status":{"$ref":"#/components/schemas/PostOrderResponseTypeWriteOffItemsStatus","description":"The status of the write-off."},"writeOffCreditMemoNumber":{"type":"string","maxLength":255,"description":"The number of the credit memo that is written off."}},"title":"PostOrderResponseTypeWriteOffItems"},"PostOrderResponseType":{"type":"object","properties":{"processId":{"type":"string","description":"The ID of the process that handles the operation.\n"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderResponseTypeReasonsItems"},"description":"The container of the error code and message. This field is available only if the `success` field is `false`.\n"},"requestId":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"Unique identifier of the request.\n"},"success":{"type":"boolean","description":"Indicates whether the call succeeded.\n"},"accountId":{"type":"string","maxLength":32,"description":"The account ID for the order. This field is returned instead of the `accountNumber` field if the `returnIds` query parameter is set to `true`."},"accountNumber":{"type":"string","maxLength":50,"description":"The account number for the order."},"commitments":{"type":"array","items":{"$ref":"#/components/schemas/CommitmentOutput"},"description":"The commitments created by this order request."},"creditMemoIds":{"type":"array","items":{"type":"string","maxLength":32},"description":"An array of the credit memo IDs generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled. This field is returned instead of the `creditMemoNumbers` field if the `returnIds` query parameter is set to `true`."},"creditMemoNumbers":{"type":"array","items":{"type":"string","maxLength":255},"description":"An array of the credit memo numbers generated in this order request. The credit memo is only available if you have the Invoice Settlement feature enabled."},"invoiceIds":{"type":"array","items":{"type":"string","maxLength":32},"description":"An array of the invoice IDs generated in this order request. Normally it includes one invoice ID only, but can include multiple items when a subscription was tagged as invoice separately. This field is returned instead of the `invoiceNumbers` field if the `returnIds` query parameter is set to `true`."},"invoiceNumbers":{"type":"array","items":{"type":"string","maxLength":255},"description":"An array of the invoice numbers generated in this order request. Normally it includes one invoice number only, but can include multiple items when a subscription was tagged as invoice separately."},"orderId":{"type":"string","maxLength":32,"description":"The ID of the order created. This field is returned instead of the `orderNumber` field if the `returnIds` query parameter is set to `true`."},"orderLineItems":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderResponseTypeOrderLineItemsItems"},"description":"[Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) are non subscription based items created by an Order, representing transactional charges such as one-time fees, physical goods, or professional service charges that are not sold as subscription services. \n\nWith the Order Line Items feature enabled, you can now launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models. \n\n**Note:** The [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature is now generally available to all Zuora customers. You need to enable the [Orders](https://knowledgecenter.zuora.com/BC_Subscription_Management/Orders/AA_Overview_of_Orders#Orders) feature to access the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items/AA_Overview_of_Order_Line_Items) feature. As of Zuora Billing Release 313 (November 2021), new customers who onboard on [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) will have the [Order Line Items](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Order_Line_Items) feature enabled by default.\n"},"orderNumber":{"type":"string","maxLength":100,"description":"The order number of the order created."},"paidAmount":{"type":"string","minLength":9,"maxLength":22,"description":"The total amount collected in this order request."},"paymentId":{"type":"string","maxLength":32,"description":"The payment Id that is collected in this order request. This field is returned instead of the `paymentNumber` field if the `returnIds` query parameter is set to `true`."},"paymentNumber":{"type":"string","maxLength":32,"description":"The payment number that is collected in this order request."},"ramps":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderResponseTypeRampsItems"},"description":"**Note**: This field is only available if you have the Ramps feature enabled. The [Orders](https://docs.zuora.com/en/zuora-billing/manage-accounts-subscriptions-and-non-subscriptions/manage-subscription-transactions/orders/orders-introduction/overview-of-orders) feature must be enabled before you can access the [Ramps](https://knowledgecenter.zuora.com/Billing/Subscriptions/Orders/Ramps_and_Ramp_Metrics/A_Overview_of_Ramps_and_Ramp_Metrics) feature. The Ramps feature is available for customers with Enterprise and Nine editions by default. If you are a Growth customer, see [Zuora Editions](https://docs.zuora.com/en/entitlements/current-entitlements/zuora-editions) for pricing information coming October 2020.\n\nThe ramp definitions created by this order request.\n"},"refunds":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderResponseTypeRefundsItems"},"description":"Container for refunds."},"status":{"$ref":"#/components/schemas/PostOrderResponseTypeStatus","description":"Status of the order. `Pending` is only applicable for an order that contains a `CreateSubscription` order action."},"subscriptionIds":{"type":"array","items":{"type":"string","maxLength":32},"description":"Container for the subscription IDs of the subscriptions in an order. This field is returned if the `returnIds` query parameter is set to `true`."},"writeOff":{"type":"array","items":{"$ref":"#/components/schemas/PostOrderResponseTypeWriteOffItems"},"description":"Container for write-offs."}},"description":"Response information of orders.","title":"PostOrderResponseType"},"OrderStatus":{"type":"string","enum":["Draft","Pending","Completed","Cancelled","Scheduled","Executing","Failed"],"description":"The status of the order. If the order contains any `Pending Activation` or `Pending Acceptance` subscription, the order status will be `Pending`; If the order is in draft status, the order status will be `Draft`; otherwise the order status is `Completed`.\n\nThe available order statuses are as follow:\n- `Draft`: The order is in draft status.\n- `Pending`: The order is in pending status.\n- `Completed`: The order is in completed status.\n- `Cancelled`: The draft or scheduled order is cancelled.\n- `Scheduled`: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.\n- `Executing`: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.\n- `Failed`: The scheduled order has failed.\n","title":"OrderStatus"},"OrderSubscriptionsItemsExternallyManagedBy":{"type":"string","enum":["Amazon","Apple","Google","Roku"],"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.\n","title":"OrderSubscriptionsItemsExternallyManagedBy"},"ChargeOverrideBillingBillCycleType":{"type":"string","enum":["DefaultFromCustomer","SpecificDayofMonth","SubscriptionStartDay","ChargeTriggerDay","SpecificDayofWeek"],"description":"Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n","title":"ChargeOverrideBillingBillCycleType"},"ChargeOverrideBillingBillingPeriod":{"type":"string","enum":["Month","Quarter","Semi_Annual","Annual","Eighteen_Months","Two_Years","Three_Years","Five_Years","Specific_Months","Subscription_Term","Week","Specific_Weeks","Specific_Days"],"description":"Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n","title":"ChargeOverrideBillingBillingPeriod"},"ChargeOverrideBillingBillingPeriodAlignment":{"type":"string","enum":["AlignToCharge","AlignToSubscriptionStart","AlignToTermStart"],"description":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `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.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n\n**Note**: This field is not supported in one time charges. \n","title":"ChargeOverrideBillingBillingPeriodAlignment"},"ChargeOverrideBillingBillingTiming":{"type":"string","enum":["IN_ADVANCE","IN_ARREARS"],"description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n","title":"ChargeOverrideBillingBillingTiming"},"ChargeOverrideBillingWeeklyBillCycleDay":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"description":"Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n","title":"ChargeOverrideBillingWeeklyBillCycleDay"},"ChargeOverrideBilling":{"type":"object","properties":{"billCycleDay":{"type":"integer","minimum":0,"maximum":31,"description":"Day of the month that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofMonth`.\n"},"billCycleType":{"$ref":"#/components/schemas/ChargeOverrideBillingBillCycleType","description":"Specifies how Zuora determines the day that each billing period begins on.\n\n * `DefaultFromCustomer` - Each billing period begins on the bill cycle day of the account that owns the subscription.\n * `SpecificDayofMonth` - Use the `billCycleDay` field to specify the day of the month that each billing period begins on.\n * `SubscriptionStartDay` - Each billing period begins on the same day of the month as the start date of the subscription.\n * `ChargeTriggerDay` - Each billing period begins on the same day of the month as the date when the charge becomes active.\n * `SpecificDayofWeek` - Use the `weeklyBillCycleDay` field to specify the day of the week that each billing period begins on.\n"},"billingPeriod":{"$ref":"#/components/schemas/ChargeOverrideBillingBillingPeriod","description":"Billing frequency of the charge. The value of this field controls the duration of each billing period.\n\nIf the value of this field is `Specific_Days`, `Specific_Months` or `Specific_Weeks`, use the `specificBillingPeriod` field to specify the duration of each billing period.\n"},"billingPeriodAlignment":{"$ref":"#/components/schemas/ChargeOverrideBillingBillingPeriodAlignment","description":"Specifies how Zuora determines when to start new billing periods. You can use this field to align the billing periods of different charges.\n\n* `AlignToCharge` - Zuora starts a new billing period on the first billing day that falls on or after the date when the charge becomes active.\n* `AlignToSubscriptionStart` - Zuora starts a new billing period on the first billing day that falls on or after the start date of the subscription.\n* `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.\n\nSee the `billCycleType` field for information about how Zuora determines the billing day.\n\n**Note**: This field is not supported in one time charges. \n"},"billingTiming":{"$ref":"#/components/schemas/ChargeOverrideBillingBillingTiming","description":"Specifies whether to invoice for a billing period on the first day of the billing period (billing in advance) or the first day of the next billing period (billing in arrears).\n"},"specificBillingPeriod":{"type":"integer","description":"Duration of each billing period in months or weeks, depending on the value of the `billingPeriod` field. Only applicable if the value of the `billingPeriod` field is `Specific_Months` or `Specific_Weeks`.\n"},"weeklyBillCycleDay":{"$ref":"#/components/schemas/ChargeOverrideBillingWeeklyBillCycleDay","description":"Day of the week that each billing period begins on. Only applicable if the value of the `billCycleType` field is `SpecificDayofWeek`.\n"}},"description":"Billing information about the charge.\n","title":"ChargeOverrideBilling"},"ChargeOverrideChargeFunction":{"type":"string","enum":["CommitmentTrueUp","CreditCommitment"],"description":"**Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled.\n\nWith this field, you can use a standalone order to subscribe to a minimum commitment subscription.\n\nThis field defines what type of charge it is:\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. \n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n","title":"ChargeOverrideChargeFunction"},"ChargeOverrideCreditOption":{"type":"string","enum":["TimeBased","ConsumptionBased","FullCreditBack"],"description":"**Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled.\n\nWith this field, you can use a standalone order to subscribe to a minimum commitment subscription.\n\nThis field defines 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.\n","title":"ChargeOverrideCreditOption"},"ChargeOverrideDrawdownScope":{"type":"string","enum":["SUBSCRIPTION","ACCOUNT"],"description":"The scope in which the funds are applicable for the usage drawdown charges during drawdown. Valid for the charge with function of `Prepayment` or `CommitmentTrueUp`.\n\n\n- `SUBSCRIPTION` - only usage charges of the same subscription can be drawn down. \n- `ACCOUNT` - only usage charges in the same account (subscription owner) can be drawn down. \n\n\n**Note:** This field is only available if you have the Prepaid with Drawdown feature enabled.\n","title":"ChargeOverrideDrawdownScope"},"ChargeOverridePrepaymentUnitType":{"type":"string","enum":["UNIT","CURRENCY"],"description":"The unit type of the prepayment charge.\n\nFor topup (recurring/one-time) charges, this field indicates what type of funds are created. For drawdown (usage) charges, this field indicates what type of funds are drawn down from those created by topup charges.\n- If the prepaid charge is `UNIT`, it will create a fund with given prepaidUom. \n- If the prepaid charge is `CURRENCY`, it will create a fund with the currency amount calculated in list price.\n \n\n**Note:** This field is only available if you have the Prepaid with Drawdown feature enabled.\n","title":"ChargeOverridePrepaymentUnitType"},"RecurringCalculatedPricingOverrideGetOrder":{"type":"object","properties":{"clearingExistingMinimumAmount":{"type":"boolean","description":"Set this field to `true` to reset the minimum amount to null.\n"},"clearingExistingMaximumAmount":{"type":"boolean","description":"Set this field to `true` to reset the maximum amount to null.\n"},"eligibleAccountConditions":{"type":"object","additionalProperties":{"description":"Any type"},"description":"A filter expression (single condition or nested condition groups with logical relations) that defines which accounts’ charges are considered in the calculation. \n"},"eligibleChargeConditions":{"type":"object","additionalProperties":{"description":"Any type"},"description":"A filter expression (single condition or nested condition groups with logical relations) that defines which rate plan charges contribute to the calculation; if omitted, the scope defaults to “All charges” (i.e., all charges under the selected accounts are eligible).\n"},"minimumAmount":{"type":"number","format":"double","description":"Non-negative currency amount that establishes the lower bound for the calculated charge in a billing period. If the calculated amount is less than this value, the invoice amount will be set to the minimum value.\n"},"maximumAmount":{"type":"number","format":"double","description":"Non-negative currency amount that establishes the upper bound for the calculated charge in a billing period. If the calculated amount exceeds this value, the invoice amount will be set to the maximum value.\n"},"percentage":{"type":"number","format":"double","description":"The specific rate applied to the total eligible spend to determine the base invoice amount before any minimum or maximum amount is applied. \n"}},"required":["percentage"],"description":"Pricing information about a recurring charge that uses the \"calculated\" charge model.\n","title":"RecurringCalculatedPricingOverrideGetOrder"},"UsageFlatFeePricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsageFlatFeePricingOverridePriceChangeOption"},"UsageFlatFeePricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsageFlatFeePricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"listPrice":{"type":"number","format":"double","description":"Price of the charge.\n"},"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.\n"}},"description":"Pricing information about a usage charge that uses the \"flat fee\" charge model. In this charge model, the charge has a fixed price.\n","title":"UsageFlatFeePricingOverride"},"UsageOveragePricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsageOveragePricingOverridePriceChangeOption"},"UsageOveragePricingOverrideOverageUnusedUnitsCreditOption":{"type":"string","enum":["NoCredit","CreditBySpecificRate"],"description":"Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n","title":"UsageOveragePricingOverrideOverageUnusedUnitsCreditOption"},"UsageOveragePricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsageOveragePricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"includedUnits":{"type":"number","format":"double","minimum":0,"description":"Number of free units that may be consumed.\n"},"numberOfPeriods":{"type":"integer","minimum":1,"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"},"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.\n"},"overagePrice":{"type":"number","format":"double","description":"Price per overage unit consumed.\n"},"overageUnusedUnitsCreditOption":{"$ref":"#/components/schemas/UsageOveragePricingOverrideOverageUnusedUnitsCreditOption","description":"Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"},"unusedUnitsCreditRates":{"type":"number","format":"double","description":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"}},"description":"Pricing information about a usage charge that uses the \"overage\" charge model. In this charge model, the charge has an allowance of free units and a fixed price per additional unit consumed.\n","title":"UsageOveragePricingOverride"},"UsagePerUnitPricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsagePerUnitPricingOverridePriceChangeOption"},"UsagePerUnitPricingOverrideRatingGroup":{"type":"string","enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n **Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n","title":"UsagePerUnitPricingOverrideRatingGroup"},"UsagePerUnitPricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsagePerUnitPricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"listPrice":{"type":"number","format":"double","description":"Per-unit price of the charge.\n"},"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.\n"},"ratingGroup":{"$ref":"#/components/schemas/UsagePerUnitPricingOverrideRatingGroup","description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n **Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n"},"uom":{"type":"number","format":"double","description":"Unit of measure of the standalone charge.\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"}},"description":"Pricing information about a usage charge that uses the \"per unit\" charge model. In this charge model, the charge has a fixed price per unit consumed.\n","title":"UsagePerUnitPricingOverride"},"UsageTieredPricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsageTieredPricingOverridePriceChangeOption"},"UsageTieredPricingOverrideRatingGroup":{"type":"string","enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n **Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n","title":"UsageTieredPricingOverrideRatingGroup"},"UsageTieredPricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsageTieredPricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"ratingGroup":{"$ref":"#/components/schemas/UsageTieredPricingOverrideRatingGroup","description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n **Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ChargeTier"},"description":"List of cumulative pricing tiers in the charge.\n"},"uom":{"type":"string","description":"Unit of measure of the standalone charge.\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"}},"description":"Pricing information about a usage charge that uses the \"tiered pricing\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed.\n","title":"UsageTieredPricingOverride"},"UsageTieredWithOveragePricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsageTieredWithOveragePricingOverridePriceChangeOption"},"UsageTieredWithOveragePricingOverrideOverageUnusedUnitsCreditOption":{"type":"string","enum":["NoCredit","CreditBySpecificRate"],"description":"Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n","title":"UsageTieredWithOveragePricingOverrideOverageUnusedUnitsCreditOption"},"UsageTieredWithOveragePricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"numberOfPeriods":{"type":"integer","minimum":1,"description":"Number of periods that Zuora considers when calculating overage charges with overage smoothing.\n"},"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. \n"},"overagePrice":{"type":"number","format":"double","description":"Price per overage unit consumed.\n"},"overageUnusedUnitsCreditOption":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverrideOverageUnusedUnitsCreditOption","description":"Specifies whether to credit the customer for unused units.\n\nIf the value of this field is `CreditBySpecificRate`, use the `unusedUnitsCreditRates` field to specify the rate at which to credit the customer for unused units.\n"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ChargeTier"},"description":"List of cumulative pricing tiers in the charge.\n"},"unusedUnitsCreditRates":{"type":"number","format":"double","description":"Per-unit rate at which to credit the customer for unused units. Only applicable if the value of the `overageUnusedUnitsCreditOption` field is `CreditBySpecificRate`.\n"}},"description":"Pricing information about a usage charge that uses the \"tiered with overage\" charge model. In this charge model, the charge has cumulative pricing tiers that become effective as units are consumed. The charge also has a fixed price per unit consumed beyond the limit of the final tier.\n","title":"UsageTieredWithOveragePricingOverride"},"UsageVolumePricingOverridePriceChangeOption":{"type":"string","enum":["NoChange","SpecificPercentageValue","UseLatestProductCatalogPricing"],"description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n","title":"UsageVolumePricingOverridePriceChangeOption"},"UsageVolumePricingOverrideRatingGroup":{"type":"string","enum":["ByBillingPeriod","ByUsageStartDate","ByUsageRecord","ByUsageUpload"],"description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n**Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n","title":"UsageVolumePricingOverrideRatingGroup"},"UsageVolumePricingOverride":{"type":"object","properties":{"priceChangeOption":{"$ref":"#/components/schemas/UsageVolumePricingOverridePriceChangeOption","description":"Specifies how Zuora changes the price of the charge each time the subscription renews.\n\nIf the value of this field is `SpecificPercentageValue`, use the `priceIncreasePercentage` field to specify how much the price of the charge should change.\n"},"priceIncreasePercentage":{"type":"number","format":"double","minimum":-100,"description":"Specifies the percentage by which the price of the charge should change each time the subscription renews. Only applicable if the value of the `priceChangeOption` field is `SpecificPercentageValue`.\n"},"ratingGroup":{"$ref":"#/components/schemas/UsageVolumePricingOverrideRatingGroup","description":"Specifies how Zuora groups usage records when rating usage. See [Usage Rating by Group](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Usage/Usage_Rating_by_Group) for more information.\n * ByBillingPeriod (default): The rating is based on all the usages in a billing period.\n * ByUsageStartDate: The rating is based on all the usages on the same usage start date. \n * ByUsageRecord: The rating is based on each usage record.\n * ByUsageUpload: The rating is based on all the usages in a uploaded usage file (.xls or .csv). If you import a mass usage in a single upload, which contains multiple usage files in .xls or .csv format, usage records are grouped for each usage file.\n\n\n**Note:** For usage charges with **Dynamic Pricing** enabled that use a `Usage` object field to determine the price automatically, you cannot override the `ratingGroup` defined in the product catalog.\n"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/ChargeTier"},"description":"List of variable pricing tiers in the charge.\n"},"uom":{"type":"number","format":"double","description":"Unit of measure of the standalone charge.\n\n**Note:** This field is available when the Standalone Orders feature is enabled.\n"}},"description":"Pricing information about a usage charge that uses the \"volume pricing\" charge model. In this charge model, the charge has a variable price per unit, depending on how many units are consumed.\n","title":"UsageVolumePricingOverride"},"ChargeOverridePricing":{"type":"object","properties":{"chargeModelData":{"$ref":"#/components/schemas/ChargeModelDataOverride"},"discount":{"$ref":"#/components/schemas/DiscountPricingOverride"},"oneTimeFlatFee":{"$ref":"#/components/schemas/OneTimeFlatFeePricingOverride"},"oneTimePerUnit":{"$ref":"#/components/schemas/OneTimePerUnitPricingOverride"},"oneTimeTiered":{"$ref":"#/components/schemas/OneTimeTieredPricingOverride"},"oneTimeVolume":{"$ref":"#/components/schemas/OneTimeVolumePricingOverride"},"recurringCalculated":{"$ref":"#/components/schemas/RecurringCalculatedPricingOverrideGetOrder"},"recurringDelivery":{"$ref":"#/components/schemas/RecurringDeliveryPricingOverride"},"recurringFlatFee":{"$ref":"#/components/schemas/RecurringFlatFeePricingOverride"},"recurringPerUnit":{"$ref":"#/components/schemas/RecurringPerUnitPricingOverride"},"recurringTiered":{"$ref":"#/components/schemas/RecurringTieredPricingOverride"},"recurringVolume":{"$ref":"#/components/schemas/RecurringVolumePricingOverride"},"usageFlatFee":{"$ref":"#/components/schemas/UsageFlatFeePricingOverride"},"usageOverage":{"$ref":"#/components/schemas/UsageOveragePricingOverride"},"usagePerUnit":{"$ref":"#/components/schemas/UsagePerUnitPricingOverride"},"usageTiered":{"$ref":"#/components/schemas/UsageTieredPricingOverride"},"usageTieredWithOverage":{"$ref":"#/components/schemas/UsageTieredWithOveragePricingOverride"},"usageVolume":{"$ref":"#/components/schemas/UsageVolumePricingOverride"}},"description":"Pricing information about the charge.\n","title":"ChargeOverridePricing"},"ChargeOverrideProrationOption":{"type":"string","enum":["NoProration","TimeBasedProration","DefaultFromTenantSetting","ChargeFullPeriod","CustomizeProrationOptionOverrides"],"description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Usage charge proration and Charge level proration option for a recurring charge.\n\nYou can use this field to specify the charge-level proration option for a usage charge or recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden.\n * `NoProration`: charge-level proration option that you can set for a usage charge. This option means to not use any proration, which is the default current system behavior for a usage charge.\n * `TimeBasedProration`: charge-level proration option that you can set for a usage charge. This option means to prorate the usage charge amount using the actual number of days if the billing period is a partial period.\n * `DefaultFromTenantSetting`: charge-level proration option that you can set for a recurring charge. This option means to follow the customer billing rule proration setting.\n * `ChargeFullPeriod`: charge-level proration option that you can set for a recurring charge. This options means to charge the full period amount for a partial billing period. Note that this setting means that there is no proration for either collecting or refunding. Even if you cancel the recurring charge in the middle of a billing period, there is no refund for this billing period.\n * `CustomizeProrationOptionOverrides`: charge-level proration option that you can set for a recurring charge. This option means to use the customized charge proration settings that is specified by the `ratingPropertiesOverride` field.\n","title":"ChargeOverrideProrationOption"},"ChargeOverrideRatingPropertiesOverrideProrationUnit":{"type":"string","enum":["ProrateByDay","ProrateByMonthFirst"],"description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nUse this field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden.\n","title":"ChargeOverrideRatingPropertiesOverrideProrationUnit"},"ChargeOverrideRatingPropertiesOverrideDaysInMonth":{"type":"string","enum":["UseActualDays","Assume30Days","Assume30DaysStrict"],"description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nUse this field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in Proration.\n","title":"ChargeOverrideRatingPropertiesOverrideDaysInMonth"},"ChargeOverrideRatingPropertiesOverride":{"type":"object","properties":{"isProratePartialMonth":{"type":"boolean","description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nUse this field to specify whether to prorate the recurring charge for a partial month. The tenant-level proration option will be overridden.\n"},"prorationUnit":{"$ref":"#/components/schemas/ChargeOverrideRatingPropertiesOverrideProrationUnit","description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nUse this field to specify the unit of proration for a recurring charge. The tenant-level proration option will be overridden.\n"},"daysInMonth":{"$ref":"#/components/schemas/ChargeOverrideRatingPropertiesOverrideDaysInMonth","description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nUse this field to specify the number of days counted for a month when prorating a recurring charge. The tenant-level proration option will be overridden. See more details for each of the following enum values in Proration.\n"}},"description":"**Note**: This field is only available if you have the Charge Level Proration feature enabled. For more information, see Charge level proration option for a recurring charge.\n\nThis field is used only when the value of the `prorationOption` field is set to `CustomizeProrationOptionOverrides`. \n\nUse this field to specify more customized proration options for a recurring charge when you creating or adding a subscription rate plan charge through an order. The tenant-level proration option will be overridden.\n","title":"ChargeOverrideRatingPropertiesOverride"},"ChargeOverrideRevRecTriggerCondition":{"type":"string","enum":["Contract Effective Date","Service Activation Date","Customer Acceptance Date"],"description":"Specifies the revenue recognition trigger condition.\n\n * `Contract Effective Date` \n * `Service Activation Date`\n * `Customer Acceptance Date`\n","title":"ChargeOverrideRevRecTriggerCondition"},"ChargeOverrideRevenueRecognitionTiming":{"type":"string","enum":["Upon Billing Document Posting Date","Upon Order Activation Date"],"description":"Specifies the type of revenue recognition timing.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n","title":"ChargeOverrideRevenueRecognitionTiming"},"ChargeOverrideRevenueAmortizationMethod":{"type":"string","enum":["Immediate","Ratable Using Start And End Dates"],"description":"Specifies the type of revenue amortization method.\n\nPredefined 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.\n\n**Note**: This field is only available if you have the Order to Revenue feature enabled. \n","title":"ChargeOverrideRevenueAmortizationMethod"},"ChargeOverrideRolloverApply":{"type":"string","enum":["ApplyFirst","ApplyLast"],"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.\n\nThis field defines the priority of rollover, which is either first or last.\n","title":"ChargeOverrideRolloverApply"},"TriggerParamsStartDatePolicy":{"type":"string","enum":["AlignToApplyToCharge","SpecificDate","EndOfLastInvoicePeriodOfApplyToCharge","FixedPeriodAfterApplyToChargeStartDate"],"description":"Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable 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 to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n","title":"TriggerParamsStartDatePolicy"},"TriggerParamsStartPeriodsType":{"type":"string","enum":["Days","Weeks","Months","Years"],"description":"Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable 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 to access this field.\n","title":"TriggerParamsStartPeriodsType"},"TriggerParamsTriggerEvent":{"type":"string","enum":["ContractEffective","ServiceActivation","CustomerAcceptance","SpecificDate"],"description":"Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n","title":"TriggerParamsTriggerEvent"},"TriggerParams":{"type":"object","properties":{"periodsAfterChargeStart":{"type":"integer","description":"Duration of the discount charge in days, weeks, months, or years, depending on the value of the `startPeriodsType` field. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable 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 to access this field.\n"},"specificTriggerDate":{"type":"string","format":"date","description":"Date in YYYY-MM-DD format. Only applicable if the value of the `triggerEvent` field is `SpecificDate`. \n\nWhile this field is applicable, if this field is not set, your `CreateSubscription` order action creates a `Pending` order and a `Pending Acceptance` subscription. If at the same time the service activation date is required and not set, a `Pending Activation` subscription is created.\n\nWhile this field is applicable, if this field is not set, the following order actions create a `Pending` order but do not impact the subscription status. **Note**: This feature is in **Limited Availability**. If you want to have access to the feature, submit a request at [Zuora Global Support](http://support.zuora.com/).\n * AddProduct\n * UpdateProduct\n * RemoveProduct\n * RenewSubscription\n * TermsAndConditions\n"},"startDatePolicy":{"$ref":"#/components/schemas/TriggerParamsStartDatePolicy","description":"Start date policy of the discount charge to become active when the **Apply to billing period partially** checkbox is selected from the product catalog UI or the `applyToBillingPeriodPartially` field is set as true from the \"CRUD: Create a product rate plan charge\" operation. \n\n- If the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n- If the value of this field is `FixedPeriodAfterApplyToChargeStartDate`, the charge is active for a predefined duration based on the value of the `upToPeriodsType` and `upToPeriods` fields.\n\n**Notes**: \n - You must enable 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 to access this field. \n - You can use either `triggerEvent` or `startDatePolicy` to define when a discount charge starts, but not both at the same time.\n"},"startPeriodsType":{"$ref":"#/components/schemas/TriggerParamsStartPeriodsType","description":"Unit of time that the discount charge duration is measured in. Only applicable if the value of the `startDatePolicy` field is `FixedPeriodAfterApplyToChargeStartDate`.\n\n**Note**: You must enable 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 to access this field.\n"},"triggerEvent":{"$ref":"#/components/schemas/TriggerParamsTriggerEvent","description":"Condition for the charge to become active.\n\nIf the value of this field is `SpecificDate`, use the `specificTriggerDate` field to specify the date when the charge becomes active.\n"}},"description":"Specifies when a charge becomes active.\n","title":"TriggerParams"},"ChargeOverrideTaxMode":{"type":"string","enum":["TaxExclusive","TaxInclusive"],"description":"The tax mode of a charge. This field is available when the `taxable` field is set to `true`.\n","title":"ChargeOverrideTaxMode"},"ChargeOverrideValidityPeriodType":{"type":"string","enum":["SUBSCRIPTION_TERM","ANNUAL","SEMI_ANNUAL","QUARTER","MONTH"],"description":"**Note**: This field is only available if you have enabled either of the following:\n* Prepaid with Drawdown\n* Minimum Commitment\n* Both Minimum Commitment and Standalone Orders\n\nYou can use this field in the following scenarios: \n* When you create a [prepayment charge](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/J_Billing_Operations/Prepaid_with_Drawdown/Create_prepayment_charge), use this field to define the period in which the prepayment units are valid to use.\n\n* When you override the setting of commitment true-up charge from the product catalog, set this field consistently with the value of the `billing` > `billingPeriod` field in this charge.\n\n* When you use a standalone order to create a commitment true-up charge, set this field consistently with the value of the `billing` > `billingPeriod` field in this charge.\n","title":"ChargeOverrideValidityPeriodType"},"ChargeOverride":{"type":"object","properties":{"accountReceivableAccountingCode":{"type":"string","description":"The accountReceivableAccountingCode of a standalone charge.\n\n**Note:** This field is available when the Standalone Orders, Zuora Finance, and Invoice Settlement features are enabled.\n"},"adjustmentLiabilityAccountingCode":{"type":"string","description":"The adjustmentLiabilityAccountingCode of a standalone charge.\n\n**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.\n"},"adjustmentRevenueAccountingCode":{"type":"string","description":"The adjustmentRevenueAccountingCode of a standalone charge.\n\n**Note:** This field is available when the Standalone Orders feature and the Billing - Revenue Integration or Order to Revenue feature are enabled.\n"},"billing":{"$ref":"#/components/schemas/ChargeOverrideBilling","description":"Billing information about the charge.\n"},"chargeFunction":{"$ref":"#/components/schemas/ChargeOverrideChargeFunction","description":"**Note**: This field is only available if you have both the Prepaid with Drawdown and Standalone Orders features enabled.\n\nWith this field, you can use a standalone order to subscribe to a minimum commitment subscription.\n\nThis field defines what type of charge it is:\n* CommitmentTrueUp: For recurring charges. Currency based minimum commitment charge. \n* CreditCommitment: For usage charges. Credit to minimum commitment funds.\n"},"creditOption":{"$ref":"#/components/schemas/ChargeOverrideCreditOption","description":"**Note**: This field is only available if you have both the Minimum Commitment and Standalone Orders features enabled.\n\nWith this field, you can use a standalone order to subscribe to a minimum commitment subscription.\n\nThis field defines 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.\n"},"chargeModel":{"type":"string","description":"The chargeModel of a standalone charge.\n\n\nSupported charge models:\n\n* `FlatFee`\n\n* `PerUnit`\n\n* `Volume`\n\n* `Tiered`\n\n* `DiscountFixedAmount`\n\n* `DiscountPercentage`\n\n\n**Note:** This field is available when the *customField*__c. Custom field names are case sensitive. See Manage Custom Fields for more information.\n","title":"PostCreateBillingAdjustmentRequestTypeCreditMemoCustomFields"},"POSTCreateBillingAdjustmentRequestType":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The account number for which the delivery adjustment is created. \n\n**Note**: \n - The account number should be of the subscription owner.\n - Only one of accountNumber or subscriptionNumber should be provided.\n"},"chargeNumbers":{"type":"array","items":{"type":"string"},"description":"An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n"},"deferredRevenueAccountingCode":{"type":"string","description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**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.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"},"exclusion":{"type":"array","items":{"$ref":"#/components/schemas/PostCreateBillingAdjustmentRequestTypeExclusionItems"},"description":"The charge numbers and the corresponding dates for exclusion of delivery adjustment.\n"},"reason":{"type":"string","description":"The reason for the delivery adjustment.\n"},"recognizedRevenueAccountingCode":{"type":"string","description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**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.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n\n\n**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.\n"},"startDate":{"type":"string","format":"date","description":"The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"},"subscriptionNumber":{"type":"string","description":"The subscription number for which the delivery adjustment is created.\n\n**Note**: Only one of accountNumber or subscriptionNumber should be provided.\n"},"type":{"$ref":"#/components/schemas/PostCreateBillingAdjustmentRequestTypeType","description":"The type of delivery adjustment.\n"},"creditMemoCustomFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/PostCreateBillingAdjustmentRequestTypeCreditMemoCustomFields"},"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.\n"}},"required":["endDate","startDate"],"title":"POSTCreateBillingAdjustmentRequestType"},"GetAdjustmentsResponseTypeReasonsItems":{"type":"object","properties":{"code":{"type":"string","description":"The error code of response.\n"},"message":{"type":"string","description":"The detail information of the error response\n"}},"title":"GetAdjustmentsResponseTypeReasonsItems"},"POSTAdjustmentResponseType":{"type":"object","properties":{"adjustmentId":{"type":"string","format":"UUID","description":"The system generated delivery adjustment ID.\n"},"adjustmentNumber":{"type":"string","format":"string","description":"The system generated delivery adjustment number.\n"},"amount":{"type":"number","format":"double","description":"The amount of the delivery adjustment.\n"},"billingDate":{"type":"string","format":"date","description":"The billing date is same as the delivery date of the delivery adjustment, in `yyyy-mm-dd` format.\n"},"chargeNumber":{"type":"string","description":"The charge number in the subscription for which the delivery adjustment is created.\n"},"creditMemoNumber":{"type":"string","description":"The Credit Memo generated for the delivery adjustment.\n"},"deferredRevenueAccountingCode":{"type":"string","description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**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.\n"},"deliveryDate":{"type":"string","format":"date","description":"The delivery adjustment date, in `yyyy-mm-dd` format.\n"},"deliveryDay":{"type":"string","description":"The delivery adjustment day of the week.\n"},"eligible":{"type":"boolean","description":"The eligible flag is set as true for a successfully created delivery adjustment.\n"},"reason":{"type":"string","description":"The reason for the delivery adjustment.\n"},"recognizedRevenueAccountingCode":{"type":"string","description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**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.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n\n**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.\n"},"status":{"type":"string","description":"The status of the delivery adjustment will be `Billed` or `Cancelled`.\n"},"subscriptionNumber":{"type":"string","description":"The subscription number for which the delivery adjustment is created.\n"}},"title":"POSTAdjustmentResponseType"},"POSTIneligibleAdjustmentResponseType":{"type":"object","properties":{"adjustmentId":{"type":"string","format":"UUID","description":"The system generated delivery adjustment ID.\n"},"adjustmentNumber":{"type":"string","format":"string","description":"The system generated delivery adjustment number.\n"},"amount":{"type":"number","format":"double","description":"The amount of the delivery adjustment.\n"},"billingDate":{"type":"string","format":"date","description":"The billing date of the delivery adjustment.\n"},"chargeNumber":{"type":"string","description":"The charge number in the subscription for which the delivery adjustment is created.\n"},"deferredRevenueAccountingCode":{"type":"string","description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**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.\n"},"deliveryDate":{"type":"string","format":"date","description":"The delivery adjustment date, in `yyyy-mm-dd` format.\n"},"deliveryDay":{"type":"string","format":"string","description":"The delivery adjustment day of the week.\n"},"eligible":{"type":"boolean","description":"The eligible flag is set as false for an unsuccessful delivery adjustment.\n"},"errorMessage":{"type":"string","description":"The reason due to which a delivery adjustment is not eligible on the given date. \n"},"reason":{"type":"string","description":"The reason for the delivery adjustment.\n"},"recognizedRevenueAccountingCode":{"type":"string","description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**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.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n\n**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.\n"},"status":{"type":"string","description":"The status of the delivery adjustment.\n"},"subscriptionNumber":{"type":"string","description":"The subscription number for which the delivery adjustment is created.\n"}},"title":"POSTIneligibleAdjustmentResponseType"},"GETAdjustmentsResponseType":{"type":"object","properties":{"processId":{"type":"string","description":"The ID of the process that handles the operation.\n"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/GetAdjustmentsResponseTypeReasonsItems"},"description":"The container of the error code and message. This field is available only if the `success` field is `false`.\n"},"requestId":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"Unique identifier of the request.\n"},"success":{"type":"boolean","description":"Indicates whether the call succeeded.\n"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/POSTAdjustmentResponseType"},"description":"Container for delivery adjustments of a subscription.\n"},"ineligibleAdjustments":{"type":"array","items":{"$ref":"#/components/schemas/POSTIneligibleAdjustmentResponseType"},"description":"Container for ineligible delivery adjustments of a subscription.\n"},"totalAmount":{"type":"number","format":"double","description":"The total amount of all the delivery adjustments.\n"},"totalNumberOfDeliveries":{"type":"number","format":"double","description":"The total number of all delivery adjustments.\n"}},"title":"GETAdjustmentsResponseType"},"PostPreviewBillingAdjustmentRequestTypeType":{"type":"string","enum":["DeliveryCredit"],"description":"The type of delivery adjustment.\n","title":"PostPreviewBillingAdjustmentRequestTypeType"},"POSTPreviewBillingAdjustmentRequestType":{"type":"object","properties":{"accountNumber":{"type":"string","description":"The account number for which the delivery adjustment is created.\n**Note**: \n - The account number should be of the subscription owner.\n - Only one of accountNumber or subscriptionNumber should be provided.\n"},"chargeNumbers":{"type":"array","items":{"type":"string"},"description":"An optional container to specify charge numbers in the subscription for which the delivery adjustment needs to be created.\n"},"deferredRevenueAccountingCode":{"type":"string","description":"The accounting code for the deferred revenue, such as Monthly Recurring Liability.\n\n**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.\n"},"endDate":{"type":"string","format":"date","description":"The end date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"},"reason":{"type":"string","description":"The reason for the delivery adjustment.\n"},"recognizedRevenueAccountingCode":{"type":"string","description":"The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.\n\n**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.\n"},"revenueRecognitionRuleName":{"type":"string","description":"The name of the revenue recognition rule governing the revenue schedule.\n\n**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.\n"},"startDate":{"type":"string","format":"date","description":"The start date of the delivery adjustment, in `yyyy-mm-dd` format. This is inclusive.\n"},"subscriptionNumber":{"type":"string","description":"The subscription number for which the delivery adjustment is created.\n\n**Note**: Only one of accountNumber or subscriptionNumber should be provided.\n"},"type":{"$ref":"#/components/schemas/PostPreviewBillingAdjustmentRequestTypeType","description":"The type of delivery adjustment.\n"}},"required":["endDate","startDate"],"title":"POSTPreviewBillingAdjustmentRequestType"},"CancelBillingAdjustmentRequestDebitMemoCustomFields":{"type":"object","properties":{},"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.\n","title":"CancelBillingAdjustmentRequestDebitMemoCustomFields"},"CancelBillingAdjustmentRequest":{"type":"object","properties":{"debitMemoCustomFields":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CancelBillingAdjustmentRequestDebitMemoCustomFields"},"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.\n"}},"description":"Information about `CancelBillingAdjustment`.\n","title":"CancelBillingAdjustmentRequest"},"GetCancelAdjustmentResponseTypeReasonsItems":{"type":"object","properties":{"code":{"type":"string","description":"The error code of response.\n"},"message":{"type":"string","description":"The detail information of the error response\n"}},"title":"GetCancelAdjustmentResponseTypeReasonsItems"},"GETCancelAdjustmentResponseType":{"type":"object","properties":{"processId":{"type":"string","description":"The ID of the process that handles the operation.\n"},"reasons":{"type":"array","items":{"$ref":"#/components/schemas/GetCancelAdjustmentResponseTypeReasonsItems"},"description":"The container of the error code and message. This field is available only if the `success` field is `false`.\n"},"requestId":{"type":"string","format":"uuid","minLength":36,"maxLength":36,"description":"Unique identifier of the request.\n"},"success":{"type":"boolean","description":"Indicates whether the call succeeded.\n"},"debitMemoNumber":{"type":"string","description":"The Debit Memo generated to write off the Credit Memo for the delivery adjustment. \n"}},"title":"GETCancelAdjustmentResponseType"},"V1BillingDocumentsGetParametersStatus":{"type":"string","enum":["Draft","Posted","Canceled","Error"],"title":"V1BillingDocumentsGetParametersStatus"},"GetBillingDocumentsResponseTypeDocumentType":{"type":"string","enum":["Invoice","CreditMemo","DebitMemo"],"description":"The type of the billing document.\n","title":"GetBillingDocumentsResponseTypeDocumentType"},"GetBillingDocumentsResponseTypeStatus":{"type":"string","enum":["Draft","Posted","Canceled","Error"],"description":"The current status of the billing document.\n","title":"GetBillingDocumentsResponseTypeStatus"},"GETBillingDocumentsResponseType":{"type":"object","properties":{"accountId":{"type":"string","format":"uuid","description":"The ID of the customer account associated with the billing document."},"amount":{"type":"number","format":"double","description":"The total amount of the billing document.\n"},"balance":{"type":"number","format":"double","description":"The balance of the billing document.\n"},"documentDate":{"type":"string","format":"date","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.\n"},"documentNumber":{"type":"string","description":"The number of the billing document.\n"},"documentType":{"$ref":"#/components/schemas/GetBillingDocumentsResponseTypeDocumentType","description":"The type of the billing document.\n"},"id":{"type":"string","description":"The ID of the billing document.\n"},"status":{"$ref":"#/components/schemas/GetBillingDocumentsResponseTypeStatus","description":"The current status of the billing document.\n"},"currency":{"type":["string","null"],"description":"The currency of the billing document.\n\n**Note:** By default, the currency on a billing document matches the default currency set on the associated account. \nHowever, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. \nFor more information, see Multiple Currency.\n"}},"title":"GETBillingDocumentsResponseType"},"BillingDocumentQueryResponseElementType":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/GETBillingDocumentsResponseType"},"description":"Container for billing documents.\n"},"nextPage":{"type":"string","format":"URL","description":"URL to retrieve the next page of the response if it exists; otherwise absent.\n"},"success":{"type":"boolean","description":"Returns `true` if the request was processed successfully."}},"title":"BillingDocumentQueryResponseElementType"},"POSTBillingDocumentFilesDeletionJobRequest":{"type":"object","properties":{"accountIds":{"type":"array","items":{"type":"string"},"description":"Container for the IDs of the accounts that you want to create the billing document files deletion job for.\n\n**Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.\n"},"accountKeys":{"type":"array","items":{"type":"string"},"description":"Container for the IDs and/or numbers of the accounts that you want to create the billing document files deletion job for.\n\n**Note**: When creating jobs to delete billing document PDF files, you must specify either set of `accountIds` or `accountKeys` in the request body.\n"}},"title":"POSTBillingDocumentFilesDeletionJobRequest"},"PostBillingDocumentFilesDeletionJobResponseStatus":{"type":"string","enum":["Pending"],"description":"The status of the billing document file deletion job.\n","title":"PostBillingDocumentFilesDeletionJobResponseStatus"},"POSTBillingDocumentFilesDeletionJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the billing document file deletion job.\n"},"status":{"$ref":"#/components/schemas/PostBillingDocumentFilesDeletionJobResponseStatus","description":"The status of the billing document file deletion job.\n"},"success":{"type":"boolean","description":"Returns `true` if the request was processed successfully."}},"title":"POSTBillingDocumentFilesDeletionJobResponse"},"GetBillingDocumentFilesDeletionJobResponseStatus":{"type":"string","enum":["Pending","Processing","Completed","Error"],"description":"The status of the billing document file deletion job.\n","title":"GetBillingDocumentFilesDeletionJobResponseStatus"},"GETBillingDocumentFilesDeletionJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the billing document file deletion job.\n"},"status":{"$ref":"#/components/schemas/GetBillingDocumentFilesDeletionJobResponseStatus","description":"The status of the billing document file deletion job.\n"},"success":{"type":"boolean","description":"Returns `true` if the request was processed successfully."}},"title":"GETBillingDocumentFilesDeletionJobResponse"},"PostGenerateBillingDocumentType":{"type":"object","properties":{"autoPost":{"type":"boolean","default":false,"description":"Whether to automatically post the billing documents after the draft billing documents are generated. \n\nIf an error occurs during posting billing documents, the draft billing documents are not generated too.\n"},"autoRenew":{"type":"boolean","default":false,"description":"Whether to automatically renew the subscriptions with **Auto Renew** set to **Yes**. \n"},"chargeTypeToExclude":{"type":"array","items":{"type":"string"},"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`. \n"},"commitmentKeys":{"type":"array","items":{"type":"string"},"description":"The IDs of the commitments to include in billing document generation.\n"},"creditMemoReasonCode":{"type":"string","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."},"effectiveDate":{"type":"string","format":"date","description":"The date on which to generate the billing documents, in `yyyy-mm-dd` format.\n"},"includeSubscriptions":{"type":"boolean","default":true,"description":"Indicates whether to bill subscriptions in the bill run.\n"},"includeOrderLineItems":{"type":"boolean","default":true,"description":"Indicates whether to bill order line items in the bill run.\n"},"subscriptionIds":{"type":"array","items":{"type":"string"},"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.\n"},"targetDate":{"type":"string","format":"date","description":"The date used to determine which charges are to be billed, in `yyyy-mm-dd` format.\n"}},"required":["effectiveDate","targetDate"],"title":"PostGenerateBillingDocumentType"},"CreditMemoResponseType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated credit memo.\n"}},"title":"CreditMemoResponseType"},"InvoiceResponseType":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated invoice.\n"}},"title":"InvoiceResponseType"},"GenerateBillingDocumentResponseType":{"type":"object","properties":{"creditMemos":{"type":"array","items":{"$ref":"#/components/schemas/CreditMemoResponseType"},"description":"Container for generated credit memos.\n\n**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.\n"},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceResponseType"},"description":"Container for generated invoics.\n"},"success":{"type":"boolean","description":"Returns `true` if the request was processed successfully."}},"title":"GenerateBillingDocumentResponseType"},"PostCreateInvoiceContactType":{"type":"object","properties":{"address1":{"type":"string","maxLength":255,"description":"First address line, 255 characters or less.\n"},"address2":{"type":"string","description":"Second address line, 255 characters or less.\n"},"city":{"type":"string","maxLength":40,"description":"City, 40 characters or less.\n"},"country":{"type":"string","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.\n"},"county":{"type":"string","maxLength":32,"description":"County; 32 characters or less. May optionally be used by Zuora Tax to calculate county tax.\n"},"fax":{"type":"string","maxLength":40,"description":"Fax phone number, 40 characters or less.\n"},"firstName":{"type":"string","maxLength":100,"description":"First name, 100 characters or less.\n"},"homePhone":{"type":"string","maxLength":40,"description":"Home phone number, 40 characters or less.\n"},"lastName":{"type":"string","maxLength":100,"description":"Last name, 100 characters or less.\n"},"mobilePhone":{"type":"string","maxLength":40,"description":"Mobile phone number, 40 characters or less.\n"},"nickname":{"type":"string","description":"Nickname for this contact\n"},"otherPhone":{"type":"string","maxLength":40,"description":"Other phone number, 40 characters or less.\n"},"otherPhoneType":{"type":"string","description":"Possible values are: `Work`, `Mobile`, `Home`, `Other`.\n"},"personalEmail":{"type":"string","format":"email","maxLength":80,"description":"Personal email address.\n"},"state":{"type":"string","description":"State; must be a valid subregion (state or province) name or code.\nFor more information, see