() {{\n put(\"InvoiceWFProcessed__c\", \"2\");\n }});\n\nInvoice updatedInvoice = zuoraClient.invoices().patchInvoice(invoicePatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst invoicePatchRequest = {\n description: \"Updated invoice\",\n document_date: \"2023-01-23\",\n pay: true,\n custom_fields: {\n InvoiceWFProcessed__c: 2,\n },\n};\n\nconst updatedInvoice = await zuoraClient.invoices.patchInvoice(invoicePatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
},
"example": {
"id": "8ad0852985cf047e0185d0c4ce891591",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-23T10:53:11-08:00",
"created_by_id": "2c92c0f971c65e010171c79a08423ccc",
"created_time": "2023-01-20T12:00:37-08:00",
"custom_fields": {
"InvoiceWFProcessed__c": "2",
"EmailSentWorkflow__c": "Unprocessed",
"LateFeeApplied__c": "False"
},
"account_id": "8ad09b7a7b3a62b9017b55d7387a72f8",
"description": "Updated invoice",
"due_date": "2023-01-23",
"document_date": "2023-01-23",
"invoice_number": "INV00008312",
"state_transitions": {},
"state": "draft",
"total": 100,
"subtotal": 100,
"tax": 0,
"remaining_balance": 100,
"paid": false,
"past_due": true
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteInvoice",
"summary": "Delete an invoice",
"tags": [
"Invoices"
],
"description": "Deletes an invoice that has not been canceled.",
"parameters": [
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl --request DELETE --url https://rest.apisandbox.zuora.com/v2/invoices/INV00008122/delete --header 'Content-Type: application/json' "
},
{
"lang": "Java",
"label": "Java",
"source": " \n Invoice deleteInvoice = zuoraClient.invoice().deleteInvoice(\"INV00008122\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \n const deleteInvoice = await zuoraClient.invoice.deleteInvoice(\"INV00008122\");\n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices": {
"get": {
"operationId": "getInvoices",
"summary": "List invoices",
"tags": [
"Invoices"
],
"description": "Returns a dictionary with a data property that contains an array of invoices, starting after cursor. Each entry in the array is a separate invoice object. If no more invoices are available, the resulting array will be empty.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl -X GET \"https://rest.sandbox.na.zuora.com/v2/invoices\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nInvoiceListResponse invoiceListResponse = zuoraClient.invoices().getinvoices(null,Collections.singletonList(\"account\"),null);\nSystem.out.println(invoiceListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoiceListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "8ad09bce80507dab0180688bdabc20cb",
"updated_time": "2023-01-31T05:22:16-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-31T05:22:15-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad08d2986023f88018607fe0b27650d",
"due_date": "2022-08-01",
"document_date": "2022-08-01",
"invoice_number": "INV0000831501234",
"state_transitions": {
"posted_at": "2023-01-31T05:22:16-08:00"
},
"posted_by_id": "8ad09bce80507dab0180688bdabc20cb",
"state": "draft",
"total": 751.5,
"subtotal": 751.5,
"tax": 0,
"amount_paid": 751.5,
"remaining_balance": 751.5,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "8ad09bce80507dab0180688bdabc20cb",
"updated_time": "2023-01-31T05:22:16-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-31T05:22:15-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad08d2986023f88018607fe0b27650d",
"due_date": "2022-08-01",
"document_date": "2022-08-01",
"invoice_number": "INV0000831501234",
"state_transitions": {
"posted_at": "2023-01-31T05:22:16-08:00"
},
"posted_by_id": "8ad09bce80507dab0180688bdabc20cb",
"state": "draft",
"total": 751.5,
"subtotal": 751.5,
"tax": 0,
"amount_paid": 751.5,
"remaining_balance": 751.5,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "8ad09bce80507dab0180688bdabc20cb",
"updated_time": "2023-01-31T05:22:16-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-31T05:22:15-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad08d2986023f88018607fe0b27650d",
"due_date": "2022-08-01",
"document_date": "2022-08-01",
"invoice_number": "INV0000831501234",
"state_transitions": {
"posted_at": "2023-01-31T05:22:16-08:00"
},
"posted_by_id": "8ad09bce80507dab0180688bdabc20cb",
"state": "draft",
"total": 751.5,
"subtotal": 751.5,
"tax": 0,
"amount_paid": 751.5,
"remaining_balance": 751.5,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "8ad09bce80507dab0180688bdabc20cb",
"updated_time": "2023-01-31T05:22:16-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-31T05:22:15-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad08d2986023f88018607fe0b27650d",
"due_date": "2022-08-01",
"document_date": "2022-08-01",
"invoice_number": "INV0000831501234",
"state_transitions": {
"posted_at": "2023-01-31T05:22:16-08:00"
},
"posted_by_id": "8ad09bce80507dab0180688bdabc20cb",
"state": "draft",
"total": 751.5,
"subtotal": 751.5,
"tax": 0,
"remaining_balance": 751.5,
"paid": false,
"past_due": true
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createInvoice",
"summary": "Create an invoice",
"tags": [
"Invoices"
],
"description": "Creates an invoice for an account.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoiceCreateRequest"
},
"example": {
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"pay": false,
"description": "Invoice Create",
"document_date": "2020-02-01",
"custom_fields": {
"field__c": "custom field value"
},
"post": true,
"items": [
{
"amount": 10,
"name": "Charge with tax amount",
"service_start": "2022-07-26",
"taxation_items": [
{
"name": "tax",
"amount": 12,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"amount_exempt": 2,
"tax_inclusive": false,
"tax_rate_type": "amount"
}
]
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices --header 'Authorization: Bearer 7ab413058c18422fa391214a1b586f4a' --header 'Content-Type: application/json' --data '{\n \"account_id\": \"8ad0934e85ab06a10185ac52f9363911\",\n \"description\": \"new invoice\",\n \"document_date\": \"2023-01-01\",\n \"post\":true,\n \"items\": [\n {\n \"amount\": 300,\n \"booking_reference\": \"PE2FGW\",\n \"name\": \"Recurring - Unit Amount Upgrade\",\n \"description\": \"A new invoice item\",\n \"service_start\": \"2023-01-01\"\n }\n ]\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nInvoiceItemCreateRequest invoiceItemRequest = new InvoiceItemCreateRequest()\n .amount(new BigDecimal(10.25))\n .bookingReference(\"PE2FGW\")\n .name(\"Recurring - Unit Amount Upgrade\")\n .description(\"A new invoice item\")\n .serviceStart(\"2023-01-01\");\n\nInvoiceCreateRequest invoiceRequest = new InvoiceCreateRequest()\n .accountId(\"8ad09c4b8262e38101826441928c1162\")\n .description(\"new invoice\")\n .documentDate(todayDate)\n .post(true)\n .items(Collections.singletonList(invoiceItemRequest));\n\nInvoice newInvoice = zuoraClient.invoices().createInvoice(invoiceRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst invoiceRequest = {\n account_id: '2c92c0f96abc17de016abd62bd0c5854',\n description: 'new invoice',\n document_date: '2023-01-01',\n post: true,\n items: [{\n amount: 300,\n booking_reference: 'PE2FGW',\t\n name: 'Recurring - Unit Amount Upgrade'\n service_start: '2022-09-01',\n }]\n}; \nconst newInvoice = await zuoraClient.invoices.createInvoice(invoiceRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "8ad09bce80507dab0180688bdabc20cb",
"updated_time": "2023-01-31T05:22:16-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-31T05:22:15-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad08d2986023f88018607fe0b27650d",
"due_date": "2022-08-01",
"document_date": "2022-08-01",
"invoice_number": "INV0000831501234",
"state_transitions": {
"posted_at": "2023-01-31T05:22:16-08:00"
},
"posted_by_id": "8ad09bce80507dab0180688bdabc20cb",
"state": "draft",
"total": 751.5,
"subtotal": 751.5,
"tax": 0,
"remaining_balance": 751.5,
"paid": false,
"past_due": true
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoice_items": {
"get": {
"operationId": "getInvoiceItems",
"summary": "List invoice items",
"tags": [
"Invoices"
],
"description": "Retrieves information about all items of invoices.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl -X GET \"https://rest.sandbox.na.zuora.com/v2/invoice_items\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\n InvoiceItemListResponse invoiceItemListResponse = zuoraClient.invoiceItems().getInvoiceItems(null, null, null);\n System.out.println(invoiceItemListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoiceItemListResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/reverse": {
"post": {
"operationId": "reverseInvoice",
"summary": "Reverse an invoice",
"tags": [
"Invoices"
],
"description": "Reverses a posted invoice.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoiceReverseRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "reverse",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices/8ad0852985cf047e0185d0c4c78814dd/reverse --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 025b1016656c414291cdb8eab069cb49' --data '{\n \"apply_date\": \"2023-01-24\",\n \"document_date\": \"2023-01-24\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nInvoiceReverseRequest invoiceReverseRequest = new InvoiceReverseRequest()\n .applyDate(todayDate)\n .documentDate(todayDate);\n\nInvoice reversedInvoice = zuoraClient.invoices().reverseInvoice(invoiceReverseRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst invoiceReverseRequest = {\n apply_date: \"2023-01-24\",\n document_date: \"2023-01-24\"\n};\n\nconst reversedInvoice = await zuoraClient.invoices.reverseInvoice(invoiceReverseRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/post": {
"post": {
"operationId": "postInvoice",
"summary": "Post an invoice",
"tags": [
"Invoices"
],
"description": "Opens a draft invoice.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices/INV00008312/post --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nInvoice postInvoice = zuoraClient.invoice().postInvoice(\"INV00008312\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst postInvoice = await zuoraClient.invoice.postInvoice(\"INV00008312\");\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/unpost": {
"post": {
"operationId": "unpostInvoice",
"summary": "Unpost an invoice",
"tags": [
"Invoices"
],
"description": "Unposts an open invoice that has not been applied or refunded, and changes its `state` to `draft`.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "unpost",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices/INV00008312/unpost --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nInvoice unpostInvoice = zuoraClient.invoice().unpostInvoice(\"INV00008312\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst unpostInvoice = await zuoraClient.invoice.unpostInvoice(\"INV00008312\");\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/email": {
"post": {
"operationId": "emailInvoice",
"summary": "Email an invoice",
"tags": [
"Invoices"
],
"description": "Emails an email to your customer.",
"parameters": [
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/pay": {
"post": {
"operationId": "payInvoice",
"summary": "Pay an invoice",
"tags": [
"Invoices"
],
"description": "Pays an invoice using an existing payment method.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/payInvoiceRequest"
},
"example": {
"amount": 22,
"currency": "USD",
"payment_date": "2023-01-31",
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"payment_method_id": "8ad08ccf8292a2d20182a95408ac6530",
"gateway_id": "2c92c0f86a8dd422016a941ee0d82c7f"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "pay",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices/8ad08d2985c4e1580185c66663924318/pay --header 'Content-Type: application/json' --data '{\n \"amount\": 22,\n \"currency\": \"USD\",\n \"payment_date\": \"2023-01-31\",\n \"account_id\": \"2c92c0f96abc17de016abd62bd0c5854\",\n \"payment_method_id\": \"8ad08ccf8292a2d20182a95408ac6530\",\n \"gateway_id\": \"2c92c0f86a8dd422016a941ee0d82c7f\"\n }' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nInvoicePayRequest payInvoiceRequest = new InvoicePayRequest()\n .amount(22)\n .accountId(\"8ad09c4b8262e38101826441928c1162\")\n .paymentDate(todayDate)\n .paymentMethodId(\"8ad08ccf8292a2d20182a95408ac6530\")\n .gatewayId(\"2c92c0f86a8dd422016a941ee0d82c7f\");\n\nInvoice payInvoice = zuoraClient.invoice().payInvoice(payInvoiceRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst payInvoiceRequest = {\n amount: 22,\n currency: \"USD\",\n payment_date: \"2023-01-31\",\n account_id: \"2c92c0f96abc17de016abd62bd0c5854\",\n payment_method_id: \"8ad08ccf8292a2d20182a95408ac6530\",\n gateway_id: \"2c92c0f86a8dd422016a941ee0d82c7f\",\n}; \n\nconst payInvoice = await zuoraClient.invoice.payInvoice(payInvoiceRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice"
},
"example": {
"id": "8ad08dc986023f76018608da69e8606a",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-31T09:22:57-08:00",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-31T09:22:57-08:00",
"payment_number": "P-00002779",
"payment_date": "2023-01-31",
"gateway_id": "Test Gateway",
"payment_method_id": "8ad08ccf8292a2d20182a95408ac6530",
"reference_id": "6168540.740581938",
"state": "posted",
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"amount": 22,
"amount_refunded": 0,
"remaining_balance": 0,
"currency": "USD",
"gateway_response": "This transaction has been approved by Test gateway.",
"gateway_response_code": "approve",
"gateway_state": "submitted",
"custom_fields": {
"field__c": "custom field value"
},
"state_transitions": {},
"gateway_state_transitions": {
"submitted_time": "2023-01-31T09:22:57-08:00"
},
"custom_objects": {}
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/cancel": {
"post": {
"operationId": "cancelInvoice",
"summary": "Cancel an invoice",
"tags": [
"Invoices"
],
"description": "Cancels an invoice. Only the invoice with the `draft` status can be canceled.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `balance`, `due_date`, `invoice_number`, `posted_by_id`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `paid`, `past_due`, `document_date`, `amount_paid`, `amount_refunded`, `payment_terms`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "cancel",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/invoices/INV00008314/cancel --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nInvoice cancelledInvoice = zuoraClient.invoice().cancelInvoice(\"INV00008314\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst cancelledInvoice = await zuoraClient.invoice.cancelInvoice(\"INV00008314\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/invoice",
"example": {
"id": "8ad09e2085eda8be0185ef854c636659",
"invoice_number": "INV00008314",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-26T11:19:28-08:00",
"updated_time": "2023-01-26T11:21:46-08:00",
"state_transitions": {},
"state": "uncollectible",
"description": "standalone invoice created from API v2",
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"total": 200,
"subtotal": 200,
"tax": 0,
"remaining_balance": 200,
"paid": false,
"past_due": true,
"document_date": "2022-08-05",
"due_date": "2022-09-01",
"custom_fields": {
"field__c": "custom field value"
}
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/invoices/{invoice_id}/write-off": {
"post": {
"operationId": "writeOffInvoice",
"summary": "Write off an invoice",
"tags": [
"Invoices"
],
"description": "Writes off an invoice",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/writeOffRequest"
},
"example": {
"document_date": "2023-02-15",
"reason_code": "Write-off"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "invoice_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the invoices, either `invoice_number` or `invoice_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad08d29865429bb0186568fc35b4b2a",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-02-15T11:31:47-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-02-15T11:31:47-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0fb7a85d63b017a8d767caf6f98",
"document_date": "2023-02-15",
"reason_code": "Write-off",
"invoice_id": "8ad08a9d7d9fbdda017da034e47c26bc",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000703",
"amount_refunded": 0,
"state_transitions": {
"posted_time": "2023-02-15T11:31:47-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 100,
"subtotal": 100,
"tax": 0,
"balance": 0
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos/{debit_memo_id}": {
"get": {
"operationId": "getDebitMemo",
"summary": "Retrieve a debit memo",
"tags": [
"Debit Memos"
],
"description": "Retrieves the debit memo with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl -X GET \"https://rest.sandbox.na.zuora.com/v2/debit_memo/8ad0855180f9da510180fbf80db40c79\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nDebitMemo debitMemoResponse = zuoraClient.debitmemo().getDebitMemo(newDebitMemo.getId(),null);\nSystem.out.println(debitMemoResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "patchDebitMemo",
"summary": "Update a debit memo",
"tags": [
"Debit Memos"
],
"description": "Updates a debit memo by setting the values of the specified fields. Any fields not provided in the request remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemoPatchRequest"
},
"example": {
"description": "Updated debit memo",
"pay": false,
"due_date": "2023-01-20",
"document_date": "2023-01-20",
"reason_code": "Charge Dispute"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/debit_memos/8ad08dc985aaee970185bd81e4024e3e --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 920896f0ac024b108cbe34e57ee3f457' --data '{\n \"description\": \"Updated debit memo\",\n \"pay\": false,\n \"due_date\": \"2023-01-20\",\n \"document_date\": \"2023-01-20\",\n \"reason_code\": \"Charge Dispute\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nDebitMemoPatchRequest debitMemoPatchRequest = new debitMemoPatchRequest()\n .description(\"Updated debit memo\")\n .pay(false)\n .dueDate(todayDate)\n .documentDate(todayDate)\n .reasonCode(\"Charge Dispute\");\n\nDebitMemo updatedDebitMemo = zuoraClient.debitMemos().patchDebitMemo(debitMemoPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst debitMemoPatchRequest = {\n description: \"Updated debit memo\",\n pay: false,\n due_date: \"2023-01-20\",\n document_date: \"2023-01-20\",\n reason_code: \"Charge Dispute\",\n};\n \nconst updatedDebitMemo = await zuoraClient.debitMemos.patchDebitMemo(debitMemoPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
},
"example": {
"id": "8ad08dc985aaee970185bd81e4024e3e",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-20T15:18:37-08:00",
"created_by_id": "8ad09bce80507dab0180688bdabc20cb",
"created_time": "2023-01-16T18:14:44-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"description": "Updated debit memo",
"due_date": "2023-01-20",
"document_date": "2023-01-20",
"reason_code": "Charge Dispute",
"debit_memo_number": "DM00000294",
"state_transitions": {},
"state": "draft",
"total": 10,
"subtotal": 10,
"tax": 0,
"remaining_balance": 10,
"paid": false,
"past_due": true
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteDebitMemo",
"summary": "Delete a debit memo",
"tags": [
"Debit Memos"
],
"description": "Permanently deletes a debit memo. This operation cannot be undone once it is performed.",
"parameters": [
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/debit_memos/2c92c0f86a8dd422016a9e7a70116b0d' --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.debitMemo().deleteDebitMemo(newDebitMemo.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst deleteDebitMemoResponse = await zuoraClient.debitMemo.deleteDebitMemo('8ad087e284427311018447079d9e4efe');\nconsole.log(deleteDebitMemoResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos": {
"get": {
"operationId": "getDebitMemoes",
"summary": "List debit memos",
"tags": [
"Debit Memos"
],
"description": "Returns a dictionary with a data property that contains an array of debit memoes, starting after cursor. Each entry in the array is a separate invoice object. If no more invoices are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl -X GET \"https://rest.sandbox.na.zuora.com/v2/debit_memo\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nDebitMemoListResponse debitMemoListResponse = zuoraClient.debitmemo().getDebitMemoes(null,Collections.singletonList(\"account\"),null);\nSystem.out.println(debitMemoListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemoListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createDebitMemo",
"summary": "Create a debit memo",
"tags": [
"Debit Memos"
],
"description": "Creates debit memo",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemoCreateRequest"
},
"example": {
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2022-08-26",
"description": "test debit memo from invoice",
"post": true,
"invoice_id": "8ad09b7d82d9662c0182daeaa9f4477e",
"items": [
{
"amount": 1,
"invoice_item_id": "8ad09b7d82d9662c0182daeaaa114781",
"sku": "SKU-00011672",
"service_start": "2022-07-26",
"taxation_items": [
{
"source_tax_item_id": "8ad09b7d82d9662c0182daeaaa174784",
"name": "taxbf3049ff",
"amount": 0.5,
"tax_code_name": "tax1",
"tax_date": "2022-08-26",
"tax_rate_name": "rate1",
"tax_rate": 0.5,
"tax_inclusive": false,
"tax_rate_type": "amount",
"tax_code": "Maintenance Charges"
},
{
"name": "tax0896ba54",
"source_tax_item_id": "8ad09b7d82d9662c0182daeaaa174783",
"amount": 1,
"tax_code_name": "tax2",
"tax_date": "2022-08-26",
"tax_rate_name": "rate2",
"tax_rate": 10,
"tax_inclusive": false,
"tax_rate_type": "percent",
"tax_code": "Maintenance Charges"
}
]
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memo --header 'Authorization: Bearer 7676db88e1a84293a6298c8d44cc141c' --header 'Content-Type: application/json' --data '{\n \"account_id\": \"2c92c0f96abc17de016abd62bd0c5854\",\n \"description\": \"debit memo from price\",\n \"document_date\": \"2022-09-01\",\n \"reason_code\": \"Ad hoc credit\",\n \"items\": [\n {\n \"price_id\": \"8ad0887182afa5d00182b017730c5fcb\",\n \"amount\": 10,\n \"quantity\": 5,\n \"description\": \"item description\",\n \"service_start\": \"2022-09-01\"\n }\n ]\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nDebitMemoItemCreateRequest debitMemoItemRequest = new DebitMemoItemCreateRequest()\n .amount(new BigDecimal(10.25))\n .subscriptionItemName(\"subscription item 1\")\n .description(\"a new debit memo item\")\n .quantity(new BigDecimal(2))\n .serviceEnd(\"2023-09-01\")\n .serviceStart(\"2022-09-01\");\n\nDebitMemoCreateRequest debitMemoRequest = new DebitMemoCreateRequest()\n .accountId(\"8ad09c4b8262e38101826441928c1162\")\n .pay(false)\n .description(\"new debit memo\")\n .documentDate(todayDate)\n .post(false)\n .items(Collections.singletonList(debitMemoItemRequest));\n\nDebitMemo newDebitMemo= zuoraClient.debitMemo().createDebitMemo(debitMemoRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst debitMemoRequest = {\n \"account_id\": \"2c92c0f96abc17de016abd62bd0c5854\",\n \"description\": \"debit memo from price\",\n \"document_date\": \"2022-09-01\",\n \"reason_code\": \"Ad hoc credit\",\n \"items\": [\n {\n \"price_id\": \"8ad0887182afa5d00182b017730c5fcb\",\n \"amount\": 10,\n \"quantity\": 5,\n \"description\": \"item description\",\n \"service_start\": \"2022-09-01\"\n }\n ]\n }; \nconst newDebitMemo = await zuoraClient.debitmemo.createDebitMemo(debitMemoRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:56:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-02-16T12:10:28-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"description": "comments",
"due_date": "2020-03-02",
"document_date": "2020-02-01",
"reason_code": "Correcting invoice error",
"debit_memo_number": "DM00000249",
"state_transitions": {
"posted": "2022-08-15T12:37:06-07:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "open",
"total": 300,
"subtotal": 300,
"tax": 0,
"balance": 290,
"paid": false,
"past_due": true
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos/{debit_memo_id}/cancel": {
"post": {
"operationId": "cancelDebitMemo",
"summary": "Cancel a debit memo",
"tags": [
"Debit Memos"
],
"description": "Cancels a debit memo. Only the debit memos with the `draft` status can be canceled.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "cancel",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memos/DM00000288/cancel --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nDebitMemo cancelledDebitMemo = zuoraClient.debitMemo().cancelDebitMemo(\"DM00000288\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst cancelledDebitMemo = await zuoraClient.debitmemo.cancelDebitMemo(\"DM00000288\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memo_items": {
"get": {
"operationId": "getDebitMemoItems",
"summary": "List debit memo items",
"tags": [
"Debit Memos"
],
"description": "Lists item information on all or a subset of debit memos.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "debit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl -X GET \"https://rest.sandbox.na.zuora.com/v2/debit_memo_items\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\n DebitMemoItemListResponse debitMemoItemListResponse = zuoraClient.debitMemoItems().getDebitMemoItems(null, null, null);\n System.out.println(debitMemoItemListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemoItemListResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos/{debit_memo_id}/post": {
"post": {
"operationId": "postsDebitMemo",
"summary": "Post a debit memo",
"tags": [
"Debit Memos"
],
"description": "Opens a draft debit memo.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memos/DM00000302/post --header 'Authorization: Bearer d1daf29d65a3476b8508a40587ef0cde' --header 'Content-Type: application/json' --data '{}' \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos/{debit_memo_id}/unpost": {
"post": {
"operationId": "unpostsDebitMemo",
"summary": "Unpost a debit memo",
"tags": [
"Debit Memos"
],
"description": "Unposts an open debit memo that has not been applied or refunded, and changes its `state` to `draft`.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "unpost",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memos/DM00000302/post --header 'Authorization: Bearer d1daf29d65a3476b8508a40587ef0cde' --header 'Content-Type: application/json' --data '{}' \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/debit_memos/{debit_memo_id}/pay": {
"post": {
"operationId": "payDebitMemo",
"summary": "Pay a debit memo",
"tags": [
"Debit Memos"
],
"description": "Pays a debit memo using an existing payment method.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/payDebitMemoRequest"
},
"example": {
"amount": 22,
"currency": "USD",
"payment_date": "2023-01-31",
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"payment_method_id": "8ad08ccf8292a2d20182a95408ac6530",
"gateway_id": "2c92c0f86a8dd422016a941ee0d82c7f"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `balance`, `due_date`, `debit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `posted_by_id`, `state`, `reason_code`, `paid`, `past_due`, `billing_document_settings`, `payment_terms`, `bill_to_id`, `invoice_id`, `currency` \n "
},
{
"in": "query",
"name": "debit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `document_item_date`, `invoice_item_id`, `sku`, `name`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `subtotal`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `debit_memo_id` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "debit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the debit_memo_id, either `debit_memo_number` or `debit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "pay",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memos/8ad09c4b84e185210184e433cb4919c1/pay --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{\n \"amount\": 22,\n \"currency\": \"USD\",\n \"payment_date\": \"2023-01-31\",\n \"account_id\": \"2c92c0f96abc17de016abd62bd0c5854\",\n \"payment_method_id\": \"8ad08ccf8292a2d20182a95408ac6530\",\n \"gateway_id\": \"2c92c0f86a8dd422016a941ee0d82c7f\"\n }' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nDebitMemoPayRequest payDebitMemoRequest = new DebitMemoPayRequest()\n .amount(22)\n .accountId(\"8ad09c4b8262e38101826441928c1162\")\n .paymentDate(todayDate)\n .paymentMethodId(\"8ad08ccf8292a2d20182a95408ac6530\")\n .gatewayId(\"2c92c0f86a8dd422016a941ee0d82c7f\");\n\nDebitMemo payDebitMemo = zuoraClient.debitmemo().payDebitMemo(payDebitMemoRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst payDebitMemoRequest = {\n amount: 22,\n currency: \"USD\",\n payment_date: \"2023-01-31\",\n account_id: \"2c92c0f96abc17de016abd62bd0c5854\",\n payment_method_id: \"8ad08ccf8292a2d20182a95408ac6530\",\n gateway_id: \"2c92c0f86a8dd422016a941ee0d82c7f\",\n}; \nconst payDebitMemo = await zuoraClient.debitmemo.payDebitMemo(\"debitMemoPayRequest\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/debitMemo"
},
"example": {
"id": "8ad08dc986023f76018608da69e8606a",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-31T09:22:57-08:00",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-31T09:22:57-08:00",
"payment_number": "P-00002779",
"payment_date": "2023-01-31",
"gateway_id": "Test Gateway",
"payment_method_id": "8ad08ccf8292a2d20182a95408ac6530",
"reference_id": "6168540.740581938",
"state": "posted",
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"amount": 22,
"amount_applied": 22,
"amount_refunded": 0,
"remaining_balance": 0,
"currency": "USD",
"external": false,
"gateway_response": "This transaction has been approved by Test gateway.",
"gateway_response_code": "approve",
"gateway_state": "submitted",
"custom_fields": {
"field__c": "custom field value"
},
"state_transitions": {},
"gateway_state_transitions": {
"submitted_time": "2023-01-31T09:22:57-08:00"
},
"custom_objects": {}
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}": {
"get": {
"operationId": "getCreditMemo",
"summary": "Retrieve a credit memo",
"tags": [
"Credit Memos"
],
"description": "Retrieves the credit memo with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl -X GET \"https://rest.sandbox.na.zuora.com/v2/credit_memos/8ad0855180f9da510180fbf80db40c79\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nCreditMemo creditMemoResponse = zuoraClient.creditMemos().getCreditMemo(newCreditMemo.getId(),null,null);\nSystem.out.println(creditMemoResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "patchCreditMemo",
"summary": "Update a credit memo",
"tags": [
"Credit Memos"
],
"description": "Updates a credit memo by setting the values of the specified fields. Any fields not provided in the request remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemoPatchRequest"
},
"example": {
"description": "Updated credit memo",
"document_date": "2023-01-16",
"reason_code": "Charge Dispute"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url 'https://rest.apisandbox.zuora.com/v2/credit_memos/8ad08c84858672100185a2662c381b35?=' --header 'Authorization: Bearer 50c3e24363864c96af0742adebd9a788' --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 50c3e24363864c96af0742adebd9a788' --data '{\n \"description\": \"Updated credit memo\",\n \"document_date\": \"2023-01-16\",\n \"reason_code\": \"Charge Dispute\"\n }' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nCreditMemoPatchRequest creditMemoPatchRequest = new CreditMemoPatchRequest()\n .description(\"Updated credit memo\")\n .documentDate(todayDate)\n .reasonCode(\"Charge Dispute\");\n\nCreditMemo updatedCreditMemo = zuoraClient.creditMemos().patchCreditMemo(creditMemoPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst creditMemoPatchRequest = {\n description: \"Updated credit memo\",\n document_date: \"2023-01-16\",\n reason_code: \"Charge Dispute\"\n};\n \nconst updatedCreditMemo = await zuoraClient.creditMemos.patchCreditMemo(creditMemoPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad08c84858672100185a2662c381b35",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-19T16:13:05-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-11T11:54:43-08:00",
"custom_fields": {
"EmailSentWorkflow__c": "Unprocessed"
},
"account_id": "8ad0823f8455bb400184633077e63aaf",
"description": "Updated credit memo",
"document_date": "2023-01-16",
"reason_code": "Charge Dispute",
"invoice_id": "8ad0889d8586720901859756c62f2959",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000658",
"amount_refunded": 0,
"state_transitions": {},
"state": "draft",
"total": 2545.65,
"subtotal": 2545.65,
"tax": 0,
"remaining_balance": 2545.65
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteCreditMemo",
"summary": "Delete a credit memo",
"tags": [
"Credit Memos"
],
"description": "Permanently deletes a credit memo. This operation cannot be undone once it is performed.",
"parameters": [
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/credit_memos/2c92c0f86a8dd422016a9e7a70116b0d' --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.creditMemo().deleteCreditMemo(newCreditMemo.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst deleteCreditMemoResponse = await zuoraClient.creditMemo.deleteCreditMemo('8ad087e284427311018447079d9e4efe');\nconsole.log(deleteCreditMemoResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos": {
"get": {
"operationId": "getCreditMemos",
"summary": "List credit memos",
"tags": [
"Credit Memos"
],
"description": "Returns a dictionary with a data property that contains an array of credit memos, starting after cursor. Each entry in the array is a separate credit memo object. If no more credit memos are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\n curl -X GET \"https://rest.sandbox.na.zuora.com/v2/credit_memos\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nCreditMemoListResponse creditMemoListResponse = zuoraClient.creditMemos().getCreditMemos(null,Collections.singletonList(\"account\"),null);\nSystem.out.println(creditMemoListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemoListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2021-12-09T13:07:18-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2021-12-09T13:07:18-08:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f86a8dd422016a9e7a70116b0d",
"document_date": "2021-12-09",
"reason_code": "Write-off",
"invoice_id": "8ad08aff7aeb7334017aec634dce2ec2",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000415",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2021-12-09T13:07:18-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 31699.88,
"subtotal": 31274.4,
"tax": 425.48,
"remaining_balance": 0
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createCreditMemo",
"summary": "Create a credit memo",
"tags": [
"Credit Memos"
],
"description": "Creates a new credit memo.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemoCreateRequest"
},
"example": {
"account_id": "8ad08ccf8437067601843a7af4e75ac8",
"description": "new credit memo",
"document_date": "2022-11-21",
"invoice_id": "8ad0950c8455ccf901846413677a40f9",
"reason_code": "Charge Dispute",
"items": [
{
"invoice_item_id": "8ad0950c8455ccf901846413679a40fa",
"amount": 100,
"service_start": "2022-11-04",
"service_end": "2023-02-01",
"name": "Music Stream Plus",
"description": "A new credit memo item"
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/credit_memos --header 'Authorization: Bearer 7676db88e1a84293a6298c8d44cc141c' --header 'Content-Type: application/json' --data '{\n \"account_id\": \"8ad08ccf806f42ed018090759555446b\",\n \"description\": \"new credit memo\",\n \"document_date\": \"2022-11-21\",\n \"invoice_id\":\"8ad0950c8455ccf901846413677a40f9\",\n \"reason_code\": \"Charge Dispute\",\n \"items\": [\n {\n \"invoice_item_id\": \"8ad0950c8455ccf901846413679a40fa\",\n \"amount\": 100,\n \"service_start\": \"2022-11-04\",\n \"service_end\": \"2023-02-01\",\n \"name\": \"Music Stream Plus\",\n \"description\":\"A new credit memo item\",\n }\n ]\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nCreditMemoItemCreateRequest creditMemoItemRequest = new CreditMemoItemCreateRequest()\n .amount(new BigDecimal(100))\n .invoiceItemId(\"8ad0950c8455ccf901846413679a40fa\")\n .name(\"Music Stream Plus\")\n .description(\"A new credit memo item\")\n .serviceEnd(\"2023-02-01\")\n .serviceStart(\"2022-11-04\");\n\nCreditMemoCreateRequest creditMemoRequest = new CreditMemoCreateRequest()\n .accountId(\"8ad08ccf806f42ed018090759555446b\")\n .description(\"new credit memo\")\n .documentDate(todayDate)\n .invoiceId(\"8ad0950c8455ccf901846413677a40f9\")\n .reasonCode(\"Charge Dispute\")\n .items(Collections.singletonList(creditMemoItemRequest));\n\nCreditMemo newCreditMemo = zuoraClient.creditMemos().createCreditMemo(creditMemoRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst creditMemoRequest = {\n account_id: \"8ad08ccf806f42ed018090759555446b\",\n description: \"new credit memo\",\n document_date: \"2022-11-21\",\n invoice_id: \"8ad0950c8455ccf901846413677a40f9\",\n reason_code: \"Charge Dispute\",\n items: [{\n invoice_item_id: \"8ad0950c8455ccf901846413679a40fa\",\t\n amount: 100,\n service_start: \"2022-11-04\",\n service_end: \"2023-02-01\",\n name : \"Music Stream Plus\",\n description: \"a new credit memo item\",\n }]\n};\n \nconst newCreditMemo = await zuoraClient.creditMemos.createCreditMemo(creditMemoRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad0855184d191a70184d4ccc64079c5",
"credit_memo_number": "CM00000600",
"account_id": "8ad08ccf8437067601843a7af4e75ac8",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-12-02T13:45:00-08:00",
"updated_time": "2022-12-02T13:45:00-08:00",
"exclude_from_auto_apply_rules": false,
"state_transitions": {},
"state": "draft",
"invoice_id": "8ad0950c8455ccf901846413677a40f9",
"description": "new credit memo",
"reason_code": "Charge Dispute",
"remaining_balance": 100,
"total": 100,
"subtotal": 100,
"tax": 0,
"document_date": "2022-11-21",
"amount_refunded": 0
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memo_items": {
"get": {
"operationId": "getCreditMemoItems",
"summary": "List credit memo items",
"tags": [
"Credit Memos"
],
"description": "Retrieves information about all items of credit memos. A credit memo item is a single line item in a credit memo.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl -X GET \"https://rest.sandbox.na.zuora.com/v2/credit_memo_items\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nCreditMemoItemListResponse creditMemoItemListResponse = zuoraClient.creditMemos().getCreditMemoItems(null, null, null);\nSystem.out.println(creditMemoItemListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemoItemListResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}/apply": {
"post": {
"operationId": "applyCreditMemo",
"summary": "Apply a credit memo",
"tags": [
"Credit Memos"
],
"description": "Apply a credit memo to one or more other billing documents.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/applyUnapplyCreditMemo"
},
"example": {
"effective_date": "2022-12-15",
"billing_documents": [
{
"type": "invoice",
"id": "8ad09e2085cf16230185cfc951f743fc",
"amount": 2,
"items": [
{
"credit_memo_item_id": "8ad0934e85d31edf0185e0120a122ae8",
"amount": 2,
"id": "8ad09e2085cf16230185cfc9521f43fd"
}
]
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "apply",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/credit_memos/8ad0855184eab9e10184f25604c91287/apply --header 'Authorization: Bearer 7676db88e1a84293a6298c8d44cc141c' --header 'Content-Type: application/json' --data '{\n \"effective_date\": \"2022-12-15\",\n \"billing_documents\": [\n {\n \"type\": \"invoice\",\n \"id\": \"8ad0950c8455ccf901846413677a40f9\",\n \"amount\": 50\n }\n ]\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nBillingDocumentApplicationRequest billingDocumentApplicationRequest = new BillingDocumentApplicationRequest()\n .type(BillingDocumentApplicationRequest.TypeEnum.INVOICE)\n .id(\"8ad0950c8455ccf901846413677a40f9\")\n .amount(new BigDecimal(50));\n\nApplyCreditMemo applyCreditMemo = new ApplyCreditMemo()\n .effectiveDate(todayDate)\n .billingDocuments(Collections.singletonList(billingDocumentApplicationRequest));\n\nCreditMemo creditMemo = zuoraClient.creditMemos().applyCreditMemo(applyCreditMemo);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst creditMemoApplyRequest = {\n \"effective_date\": \"2022-12-15\",\n \"billing_documents\": [\n {\n \"type\": \"invoice\",\n \"id\": \"8ad0950c8455ccf901846413677a40f9\",\n \"amount\": 50\n }\n ]\n};\n \nconst creditMemo = await zuoraClient.creditMemos.applyCreditMemo(creditMemoApplyRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad0934e85d31edf0185e0120a052ae5",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-24T07:06:32-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-23T11:19:16-08:00",
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"description": "test debit memo from invoice",
"document_date": "2022-08-26",
"reason_code": "Ad hoc credit",
"invoice_id": "8ad09e2085cf16230185cfc951f743fc",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000675",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2023-01-23T11:19:16-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 9,
"subtotal": 9,
"tax": 0,
"remaining_balance": 5
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}/unapply": {
"post": {
"operationId": "unapplyCreditMemo",
"summary": "Unapply a credit memo",
"tags": [
"Credit Memos"
],
"description": "Unapply an applied credit memo.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/applyUnapplyCreditMemo"
},
"example": {
"effective_date": "2022-12-15",
"billing_documents": [
{
"type": "debit_memo",
"id": "8ad0855184eab9e10184ed05d9992c9a",
"amount": 5
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "unapply",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/credit_memos/8ad0855184eab9e10184f25604c91287/unapply --header 'Authorization: Bearer 7676db88e1a84293a6298c8d44cc141c' --header 'Content-Type: application/json' --data '{\n \"effective_date\": \"2022-12-15\",\n \"billing_documents\": [\n {\n \"type\": \"invoice\",\n \"id\": \"8ad0950c8455ccf901846413677a40f9\",\n \"amount\": 50\n }\n ]\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": " \nLocalDate todayDate = LocalDate.now();\n\nBillingDocumentApplicationRequest billingDocumentApplicationRequest = new BillingDocumentApplicationRequest()\n .type(BillingDocumentApplicationRequest.TypeEnum.INVOICE)\n .id(\"8ad0950c8455ccf901846413677a40f9\")\n .amount(new BigDecimal(50));\n\nUnapplyCreditMemo unapplyCreditMemo = new UnapplyCreditMemo()\n .effectiveDate(todayDate)\n .billingDocuments(Collections.singletonList(billingDocumentApplicationRequest));\n\nCreditMemo creditMemo = zuoraClient.creditMemos().unapplyCreditMemo(unapplyCreditMemo);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst creditMemoUnapplyRequest = {\n \"effective_date\": \"2022-12-15\",\n \"billing_documents\": [\n {\n \"type\": \"invoice\",\n \"id\": \"8ad0950c8455ccf901846413677a40f9\",\n \"amount\": 50\n }\n ]\n};\n \nconst creditMemo = await zuoraClient.creditMemos.unapplyCreditMemo(creditMemoUnapplyRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
},
"example": {
"id": "8ad08551844271830184443647f96987",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2022-12-12T10:01:09-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2022-11-04T12:55:18-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "2c92c0f96abc17de016abd62bd0c5854",
"description": "credit memo from price",
"document_date": "2022-09-01",
"reason_code": "Correcting invoice error",
"exclude_from_auto_apply_rules": false,
"credit_memo_number": "CM00000508",
"amount_refunded": 0,
"state_transitions": {
"posted_at": "2022-12-08T12:07:55-08:00"
},
"posted_by_id": "2c92c0946a6dffc0016a7faab604299b",
"state": "draft",
"total": 10,
"subtotal": 10,
"tax": 0,
"remaining_balance": 5
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}/unpost": {
"post": {
"operationId": "unpostCreditMemo",
"summary": "Unpost a credit memo",
"tags": [
"Credit Memos"
],
"description": "Unposts an open credit memo that has not been applied, and changes its `state` to `draft`.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "unpost",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/credit_memos/8ad09e2085ab06ac0185bd7fbfc308f2/unpost --header 'Authorization: Bearer 787c70adc7214cd88e3dcd218ae2eee2' --header 'Content-Type: application/json' --data '{}'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nCreditMemo creditMemoResponse = zuoraClient.creditMemos().unpostCreditMemo(newCreditMemo.getId(),null,null);\nSystem.out.println(creditMemoResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}/post": {
"post": {
"operationId": "postCreditMemo",
"summary": "Post a credit memo",
"tags": [
"Credit Memos"
],
"description": "Opens a draft credit memo.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl -X GET \"https://rest.sandbox.na.zuora.com/v2/credit_memos/8ad0855180f9da510180fbf80db40c79/post\" \n -H \"Authorization: Bearer 6d151216ef504f65b8ff6e9e9e8356d3\" \n -H \"Content-Type: application/json\"\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nCreditMemo creditMemoResponse = zuoraClient.creditMemos().postCreditMemo(newCreditMemo.getId(),null,null);\nSystem.out.println(creditMemoResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/credit_memos/{credit_memo_id}/cancel": {
"post": {
"operationId": "cancelCreditMemo",
"summary": "Cancel a credit memo",
"tags": [
"Credit Memos"
],
"description": "Cancels a credit memo. Only credit memos with the Draft status can be cancelled.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "credit_memo.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `credit_memo_number`, `state_transitions`, `description`, `account_id`, `total`, `subtotal`, `tax`, `document_date`, `exclude_from_auto_apply_rules`, `posted_by_id`, `state`, `balance`, `invoice_id`, `reason_code`, `amount_refunded`, `bill_to_id`, `billing_document_settings`, `currency` \n "
},
{
"in": "query",
"name": "applied_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `id`, `amount`, `billing_document_id`, `billing_document_type` \n "
},
{
"in": "query",
"name": "credit_memo_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "taxation_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `source_tax_item_id`, `amount_applied`, `amount_refunded`, `on_account_account` \n "
},
{
"in": "query",
"name": "account.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `auto_pay`, `account_number`, `bill_to_id`, `sold_to_id`, `billing_document_settings`, `communication_profile_id`, `crm_id`, `sales_rep`, `parent_account_id`, `payment_gateway`, `payment_terms`, `remaining_credit_memo_balance`, `remaining_debit_memo_balance`, `remaining_invoice_balance`, `remaining_payment_balance`, `sequence_set_id`, `tax_certificate`, `batch`, `tax_identifier`, `bill_cycle_day`, `description`, `name`, `currency`, `default_payment_method_id`, `enabled` \n "
},
{
"in": "query",
"name": "bill_to.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `address`, `home_phone`, `first_name`, `last_name`, `email`, `work_email`, `nickname`, `other_phone`, `work_phone`, `mobile_phone`, `tax_region`, `other_phone_type`, `fax` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "credit_memo_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the credit memo, either `credit_memo_number` or `credit_memo_id`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "cancel",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/debit_memos/CM00000288/cancel --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nCreditMemo cancelledCreditMemo = zuoraClient.creditMemo().cancelCreditMemo(\"CM00000288\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst cancelledCreditMemo = await zuoraClient.creditMemo.cancelCreditMemo(\"CM00000288\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/creditMemo"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/taxation_items": {
"get": {
"operationId": "getTaxationItems",
"summary": "List taxation items",
"tags": [
"Taxation Items"
],
"description": "Returns an array of taxation items. Each entry in the array is a separate Taxation Item object. If no more taxation items are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "taxation_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url 'https://rest.apisandbox.zuora.com/v2/taxation_items' --header 'Authorization: Bearer d8a7f4d2a5ef4c3eba8618cf99593e26' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nListTaxationItemResponse taxationItemListResponse = zuoraClient.taxationItems().getTaxationItems(null,null);\nSystem.out.println(taxationItemListResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst taxationItemsResponse = await zuoraClient.taxationItems.getTaxationItems({\n filter: [\n 'id.EQ:d8a7f4d2a5ef4c3eba8618cf99593e26',\n ],\n})\n\nconsole.log(taxationItemsResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItemListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createTaxationItem",
"summary": "Create a taxation item",
"tags": [
"Taxation Items"
],
"description": "Creates a taxation item.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItemCreateRequest"
},
"example": {
"name": "tax",
"amount": 12,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"amount_exempt": 2,
"tax_inclusive": false,
"invoice_item_id": "8ad086ec85a701ce0185a782b1db3b74"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "taxation_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/taxation_items --header 'Authorization: Bearer 8d17d8e8cc36419998a205896d670ed2' --header 'Content-Type: application/json' --data '{\n \"name\": \"tax\",\n \"amount\": 12,\n \"tax_code\": \"Maintenance Charges\",\n \"tax_code_name\": \"\",\n \"tax_date\": \"2022-01-12\",\n \"tax_rate\": 1,\n \"tax_rate_name\": \"\",\n \"amount_exempt\": 2, \n \"tax_inclusive\": false,\n \"invoice_item_id\":\"8ad086ec85a701ce0185a782b1db3b74\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": " \n TaxationItemCreateRequest taxationItemCreateRequest = new TaxationItemCreateRequest()\n .tax_date(\"2022-01-12\")\n .name(\"tax\")\n .amount(12)\n .tax_code(\"Maintenance Charges\")\n .tax_rate(2)\n \n TaxationItem newTaxationItem = zuoraClient.taxationItems().createTaxationItem(taxationItemCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \n\n const taxationItemCreateRequest = {\n \"name\": \"tax\",\n \"amount\": 12,\n \"tax_code\": \"Maintenance Charges\",\n \"tax_code_name\": \"\",\n \"tax_date\": \"2022-01-12\",\n \"tax_rate\": 1,\n \"tax_rate_name\": \"\",\n \"amount_exempt\": 2,\n \"tax_inclusive\": false,\n \"invoice_item_id\":\"8ad086ec85a701ce0185a782b1db3b74\"\n };\n\n const newTaxationItem = await zuoraClient.taxationItems.createTaxationItem(taxationItemCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItem"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/taxation_items/{taxation_item_id}": {
"get": {
"operationId": "getTaxationItem",
"summary": "Retrieve a taxation item",
"tags": [
"Taxation Items"
],
"description": "Retrieves the taxation item with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "taxation_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "taxation_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the taxation item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/taxation_items/8ad099158561c2b901857ecbd9131422 --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nTaxationItem taxationItemResponse = zuoraClient.taxationItems().getTaxationItem(newTaxationItem.getId(),null);\nSystem.out.println(taxationItemResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst taxationItemResponse = await zuoraClient.taxationItems.getTaxationItem('8ad099158561c2b901857ecbd9131422');\nconsole.log(taxationItemResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItem"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "County Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updateTaxationItem",
"summary": "Update a taxation item",
"tags": [
"Taxation Items"
],
"description": "Updates a taxation item by setting the values of the specified fields. Any fields not provided in the request remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItemPatchRequest"
},
"example": {
"tax_code_name": "Forsyth",
"name": "Forsyth Charge"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "taxation_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `amount_exempt`, `tax_date`, `jurisdiction`, `location_code`, `name`, `sales_tax_payable_account`, `tax_code`, `tax_code_name`, `tax_rate`, `tax_rate_name`, `tax_inclusive`, `tax_rate_type`, `amount_credited`, `amount_paid`, `remaining_balance` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "taxation_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the taxation item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/taxation_items/8ad086ec85a701ce0185a782adb13b62 --header 'Authorization: Bearer 06a297740b184fc384bc57cbe8a04e53' --header 'Content-Type: application/json' --data '{\n \"location_code\": \"30328\",\n \"name\": \"County Charge\",\n \"tax_rate\": 1,\n \"tax_rate_name\": \"County\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nTaxationItem oldTaxationItem = zuoraClient.taxationItems().getTaxationItems(\"8ad086ec85a701ce0185a782adb13b62\", null);\n\nTaxationItemPatchRequest taxationItemPatchRequest = new TaxationItemPatchRequest()\n .name(\"County Charge\");\n\nTaxationItem updatedTaxationItem = zuoraClient.taxationItems().updateTaxationItem(oldTaxationItem.getId(),taxationItemPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst taxationItemPatchRequest = {\n \"name\": \"County Charge\",\n};\n\nconst updatedTaxationItem = await zuoraClient.taxationItems.updateTaxationItem('8ad086ec85a701ce0185a782adb13b62', taxationItemPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/taxationItem"
},
"example": {
"id": "8ad086ec85a701ce0185a782adb13b62",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-01-18T10:21:27-08:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-01-12T11:43:57-08:00",
"custom_fields": {},
"jurisdiction": "Forsyth",
"location_code": "123",
"name": "Forsyth Charge",
"amount": 0,
"tax_code": "Maintenance Charges",
"tax_code_name": "Forsyth",
"tax_date": "2022-01-12",
"tax_rate": 1,
"tax_rate_name": "Charge",
"amount_exempt": 0,
"remaining_balance": 0,
"amount_credited": 0,
"amount_paid": 0,
"tax_inclusive": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteTaxationItem",
"summary": "Delete a taxation item",
"tags": [
"Taxation Items"
],
"description": "Permanently deletes a taxation item. This operation cannot be undone once it is performed.",
"parameters": [
{
"in": "path",
"name": "taxation_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the taxation item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/taxation_items/2c92c0f86a8dd422016a9e7a70116b0d' --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.taxationItems().deleteTaxationItem(newTaxationItem.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst deleteTaxationItemResponse = await zuoraClient.taxationItems.deleteTaxationItem('8ad087e284427311018447079d9e4efe');\nconsole.log(deleteTaxationItemResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_runs": {
"get": {
"operationId": "getPaymentRuns",
"summary": "List payment runs",
"tags": [
"Payment Runs"
],
"description": "Returns an array of payment runs. Each entry in the array is a separate payment run object. If no more payment runs are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "payment_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "summary.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `number_of_unprocessed_receivables`, `number_of_errors`, `number_of_invoices`, `number_of_payments`, `number_of_credit_memos`, `number_of_debit_memos`, `number_of_unprocessed_debit_memos`, `number_of_unapplied_payments`, `errors_total`, `invoices_total`, `payments_total`, `unprocessed_receivables_total` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/payment_runs --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentRunListResponse paymentRunListResponse = zuoraClient.paymentRuns().getPaymentRuns(null,null,null);\nSystem.out.println(paymentRunListResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentRunListResponse = await zuoraClient.paymentRuns.getPaymentRuns({\n filter: [\n 'state.EQ:completed',\n ]\n});\nconsole.log(paymentRunListResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaymentRunListResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createPaymentRuns",
"summary": "Create a payment run",
"tags": [
"Payment Runs"
],
"description": "Creates a payment run.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentRunCreateRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "payment_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "summary.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `number_of_unprocessed_receivables`, `number_of_errors`, `number_of_invoices`, `number_of_payments`, `number_of_credit_memos`, `number_of_debit_memos`, `number_of_unprocessed_debit_memos`, `number_of_unapplied_payments`, `errors_total`, `invoices_total`, `payments_total`, `unprocessed_receivables_total` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/payment_runs --header 'Content-Type: application/json' --header 'x-donut-auth: Bearer 4f3a8ca735f54e9e8ea118c086dc34e1' --data '{\n \"target_date\": \"2023-02-10\",\n \"batch\": \"Batch1\",\n \"gateway_id\": \"8ad0938485cf16810185d00bf7294ec4\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nLocalDate todayDate = LocalDate.now();\n\nPaymentRunCreateRequest paymentRunCreateRequest = new PaymentRunCreateRequest()\n .gateway_id(\"8ad0938485cf16810185d00bf7294ec4\")\n .batch(\"Batch1\"),\n .targetDate(todayDate);\n \nPaymentRun newPaymentRun = zuoraClient.paymentRuns().createPaymentRun(paymentRunCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentRunCreateRequest = {\n gateway_id: 8ad0938485cf16810185d00bf7294ec4,\n batch: \"Batch1\",\n target_date: \"2022-01-12\"\n};\n\nconst newPaymentRun = await zuoraClient.paymentRuns.createPaymentRun(paymentRunCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentRun"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_runs/{payment_run_id}": {
"get": {
"operationId": "getPaymentRun",
"summary": "Retrieve a payment run",
"tags": [
"Payment Runs"
],
"description": "Retrieves the payment run information with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "payment_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "summary.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `number_of_unprocessed_receivables`, `number_of_errors`, `number_of_invoices`, `number_of_payments`, `number_of_credit_memos`, `number_of_debit_memos`, `number_of_unprocessed_debit_memos`, `number_of_unapplied_payments`, `errors_total`, `invoices_total`, `payments_total`, `unprocessed_receivables_total` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_run_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment run, either `payment_run_number` or `payment_run_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/payment_runs/8ad08c8485a701b30185a782a30a6c88 --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentRun paymentRunResponse = zuoraClient.paymentRuns().getPaymentRun(newPaymentRun.getId(),null);\nSystem.out.println(paymentRun);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentRunResponse = await zuoraClient.paymentRuns.getPaymentRun('8ad08c8485a701b30185a782a30a6c88');\nconsole.log(paymentRunResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentRun"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updatePaymentRuns",
"summary": "Update a payment run",
"tags": [
"Payment Runs"
],
"description": "Updates a payment run by setting the values of the specified fields. Any fields not provided in the request remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentRunPatchRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "payment_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `batch`, `bill_cycle_day`, `target_date`, `payment_run_number`, `state`, `apply_credit_memos`, `apply_unapplied_payments`, `bill_run_id`, `collect_payment`, `consolidate_payment`, `payment_run_date`, `payment_gateway_id`, `state_transitions` \n "
},
{
"in": "query",
"name": "summary.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `number_of_unprocessed_receivables`, `number_of_errors`, `number_of_invoices`, `number_of_payments`, `number_of_credit_memos`, `number_of_debit_memos`, `number_of_unprocessed_debit_memos`, `number_of_unapplied_payments`, `errors_total`, `invoices_total`, `payments_total`, `unprocessed_receivables_total` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_run_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment run, either `payment_run_number` or `payment_run_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/payment_runs/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{\n \"target_date\": \"2023-02-10\",\n \"batch\": \"Batch1\",\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentRun oldPaymentRun = zuoraClient.paymentRuns().getPaymentRun(\"8ad0991582aa848e0182ae9dad214dd0\");\n\nPaymentRunPatchRequest paymentRunPatchRequest = new PaymentRunPatchRequest()\n .batch(\"Batch1\"),\n .targetDate(todayDate);\n\nPaymentRun updatedPaymentRun = zuoraClient.paymentRun().updatePaymentRun(oldPaymentRun.getId(),paymentRunPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentRunId = newPaymentRun.id;\n\nconst paymentRunPatchRequest = {\n target_date: '2023-02-10',\n batch: 'Batch1',\n};\n \nconst updatedPaymentRun = await zuoraClient.paymentRuns.updatePaymentRun(paymentRunId, paymentRunPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentRun"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deletePaymentRuns",
"summary": "Delete a payment run",
"tags": [
"Payment Runs"
],
"description": "Deletes a payment run. Only the payment runs with the `canceled` or `pending` status can be deleted.",
"parameters": [
{
"in": "path",
"name": "payment_run_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment run, either `payment_run_number` or `payment_run_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/payment_runs/8f64d4d7fa661677e277dcb1ef8ee8de' --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.paymentRuns().deletePaymentRun(newPaymentRun.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst deletePaymentRunResponse = await zuoraClient.PaymentRuns.deletePaymentRun('8f64d4d7fa661677e277dcb1ef8ee8de');\nconsole.log(deletePaymentRunResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/order_line_items/{order_line_item_id}": {
"get": {
"operationId": "getOrderLineItem",
"summary": "Retrieve an order line item",
"tags": [
"Order Line Items"
],
"description": "Use this operation to retrieve the detailed information about a specific order line item.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "order_line_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the order line item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/order_line_items/8ad09b218736ff1b018749258bf15f73?=' --header 'Authorization: Bearer 9e548fc38ecd4787aa9810cb8505aacc' --header 'Content-Type: application/json' "
},
{
"lang": "Java",
"label": "Java",
"source": " \nOrderLineItem orderLineItem = zuoraClient.orderLineItems().getOrderLineItem(\"8ad09b218736ff1b018749258bf15f73\");\nSystem.out.println(orderLineItem);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst orderLineItem = await zuoraClient.orderLineItems.getOrderLineItem('8ad09b218736ff1b018749258bf15f73'); \nconsole.log(orderLineItem); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/orderLineItem"
},
"example": {
"id": "8ad09b218736ff1b018749258bf15f73",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-04-03T16:03:39-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-04-03T15:03:30-07:00",
"custom_fields": {},
"unit_of_measure": "Each",
"accounting_code": "",
"adjustment_liability_account": "",
"adjustment_revenue_account": "",
"unit_amount": 1100,
"target_date": "2023-02-15",
"deferred_revenue_account": "",
"description": "",
"discount_unit_amount": -100,
"name": "A cellphone",
"type": "product",
"list_unit_price": 1000,
"product_code": "aapl_14_pro",
"purchase_order_number": "",
"quantity": 40,
"recognized_revenue_account": "",
"related_subscription_number": "",
"revenue_recognition_rule_name": "",
"sold_to_id": "8ad09b218736ff1b018749258b9a5f70",
"tax_code": "",
"unbilled_receivables_account": "",
"revenue": {
"adjustment_revenue_account": null,
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"item_number": "1",
"category": "sale",
"state": "pending",
"price_id": "",
"quantity_available_for_return": 0,
"tax_inclusive": false,
"start_date": "2023-02-15",
"end_date": "2023-02-15",
"order_id": "8ad09b218736ff1b018749258a265f3d",
"total": 44000,
"subtotal": 44000,
"quantity_fulfilled": 0,
"quantity_pending_fulfillment": 40,
"original_order_date": "2023-02-15",
"discount_total": -4000,
"list_price": 40000,
"original_sold_to_id": "8ad09e208727f63f018734233f6d39c2"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "patchOrderLineItem",
"summary": "Update an order line item",
"tags": [
"Order Line Items"
],
"description": "Use this operation to update the information of a specific order line item.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/lineItemPatchRequest"
},
"example": {
"name": "A cellphone",
"type": "product",
"quantity": 40,
"list_unit_price": 1000,
"product_code": "aapl_14_pro",
"unit_amount": 1100,
"unit_of_measure": "Each"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "line_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `total`, `subtotal`, `quantity_fulfilled`, `quantity_pending_fulfillment`, `unit_of_measure`, `accounting_code`, `adjustment_liability_account`, `unit_amount`, `target_date`, `billing_rule`, `contract_asset_account`, `contract_liability_account`, `description`, `discount_total`, `revenue`, `discount_unit_amount`, `discount_percent`, `category`, `name`, `item_number`, `type`, `list_price`, `list_unit_price`, `original_order_date`, `original_order_id`, `original_order_line_item_id`, `original_order_line_item_number`, `original_order_number`, `product_code`, `price_id`, `purchase_order_number`, `quantity`, `quantity_available_for_return`, `related_subscription_number`, `requires_fulfillment`, `sold_to_id`, `original_sold_to_id`, `tax_code`, `tax_inclusive`, `end_date`, `start_date`, `unbilled_receivables_account`, `state`, `order_id` \n "
},
{
"in": "query",
"name": "invoice_items.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "order_line_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the order line item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url 'https://rest.apisandbox.zuora.com/v2/order_line_items/8ad09b218736ff1b018749258bf15f73?=' --header 'Authorization: Bearer 9e548fc38ecd4787aa9810cb8505aacc' --header 'Content-Type: application/json' --data '{\n \"name\": \"A cellphone\",\n \"type\": \"product\",\n \"quantity\": 40,\n \"list_unit_price\": 1000,\n \"product_code\": \"aapl_14_pro\",\n \"unit_amount\": 1100,\n \"unit_of_measure\": \"Each\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nOrderLineItemPatchRequest orderLineItemPatchRequest = new OrderLineItemPatchRequest()\n .name(\"A cellphone\")\n .quantity(40)\n .productCode(\"aapl_14_pro)\n .listUnitPrice(1000)\n .unitAmount(1100)\n .unitOfMeasure(\"Each\");\n \nOrderLineItem updatedOrderLineItem = zuoraClient.orderLineItems().patchOrderLineItem(\"8ad09b218736ff1b018749258bf15f73\", orderLineItemPatchRequest);\nSystem.out.println(updatedOrderLineItem);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst orderLineItemPatchRequest = {\n name: \"A cellphone\",\n type: \"product\",\n quantity: 40,\n list_unit_price: 1000,\n product_code: \"aapl_14_pro\",\n unit_amount: 1100,\n unit_of_measure: \"Each\"\n };\n\nconst updatedOrderLineItem = await zuoraClient.orderLineItems.patchOrderLineItem('8ad09b218736ff1b018749258bf15f73', orderLineItemPatchRequest); \nconsole.log(updatedOrderLineItem); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/orderLineItem"
},
"example": {
"id": "8ad09b218736ff1b018749258bf15f73",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-04-03T16:03:39-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-04-03T15:03:30-07:00",
"custom_fields": {},
"unit_of_measure": "Each",
"accounting_code": "",
"adjustment_liability_account": "",
"adjustment_revenue_account": "",
"unit_amount": 1100,
"target_date": "2023-02-15",
"deferred_revenue_account": "",
"description": "",
"discount_unit_amount": -100,
"name": "A cellphone",
"type": "product",
"list_unit_price": 1000,
"product_code": "aapl_14_pro",
"purchase_order_number": "",
"quantity": 40,
"recognized_revenue_account": "",
"related_subscription_number": "",
"revenue_recognition_rule_name": "",
"sold_to_id": "8ad09b218736ff1b018749258b9a5f70",
"tax_code": "",
"unbilled_receivables_account": "",
"revenue": {
"adjustment_revenue_account": null,
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"item_number": "1",
"category": "sale",
"state": "pending",
"price_id": "",
"quantity_available_for_return": 0,
"tax_inclusive": false,
"start_date": "2023-02-15",
"end_date": "2023-02-15",
"order_id": "8ad09b218736ff1b018749258a265f3d",
"total": 44000,
"subtotal": 44000,
"quantity_fulfilled": 0,
"quantity_pending_fulfillment": 40,
"original_order_date": "2023-02-15",
"discount_total": -4000,
"list_price": 40000,
"original_sold_to_id": "8ad09e208727f63f018734233f6d39c2"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/bill_run_previews/{bill_run_preview_id}": {
"get": {
"operationId": "getBillRunPreview",
"summary": "Retrieve a bill run preview",
"tags": [
"Bill Run Previews"
],
"description": "Retrieves the bill run preview information with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `assume_renewal`, `charges_excluded`, `batches`, `target_date`, `state`, `number_of_accounts`, `number_of_accounts_succeeded`, `state_transitions`, `billing_preview_run_number`, `file`, `include_draft_items`, `include_evergreen_subscriptions` \n "
},
{
"in": "query",
"name": "bill_run_preview.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `assume_renewal`, `charges_excluded`, `batches`, `target_date`, `state`, `number_of_accounts`, `number_of_accounts_succeeded`, `state_transitions`, `billing_preview_run_number`, `file`, `include_draft_items`, `include_evergreen_subscriptions` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "bill_run_preview_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the bill run preview."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/bill_runs/8ad08c8485a701b30185a782a30a6c88 --header 'Authorization: Bearer dcf5d050c6e7493688859d04da581938' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nBillRunPreview billRunPreviewResponse = zuoraClient.billRunPreviews().getBillRunPreview(newBillRunPreview.getId(),null);\nSystem.out.println(billRunPreviewResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst billRunPreviewResponse = await zuoraClient.billRunPreviews.getBillRunPreview('8ad0934e8727f642018729728eae1b2a');\nconsole.log(billRunPreviewResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billRunPreview"
},
"example": {
"id": "8ad0934e8727f642018729728eae1b2a",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28 11:19:57",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28 11:19:46",
"assume_renewal": "auto_renew_only",
"batches": [
"Batch3",
"Batch4"
],
"charges_excluded": [
"one_time",
"usage"
],
"include_draft_items": false,
"include_evergreen_subscriptions": true,
"target_date": "2023-01-01",
"state_transitions": {
"complete_time": "2023-03-28 11:19:57",
"processing_start_time": "2023-03-28 11:19:47"
},
"file": {
"url": "8ad0962d8727efba01872972b9f235a5"
},
"billing_preview_run_number": "BPR-00000039",
"state": "completed",
"number_of_accounts_succeeded": 1,
"number_of_accounts": 1
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/bill_run_previews": {
"post": {
"operationId": "createBillRunPreview",
"summary": "Create a bill run preview",
"tags": [
"Bill Run Previews"
],
"description": "Creates a bill run preview for a batch of customer accounts.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billRunPreviewCreateRequest"
},
"example": {
"include_draft_items": false,
"include_evergreen_subscriptions": true,
"charges_excluded": [
"one_time",
"usage"
],
"target_date": "2023-01-01",
"batches": [
"Batch3",
"Batch4"
],
"assume_renewal": "auto_renew_only"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `assume_renewal`, `charges_excluded`, `batches`, `target_date`, `state`, `number_of_accounts`, `number_of_accounts_succeeded`, `state_transitions`, `billing_preview_run_number`, `file`, `include_draft_items`, `include_evergreen_subscriptions` \n "
},
{
"in": "query",
"name": "bill_run_preview.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `assume_renewal`, `charges_excluded`, `batches`, `target_date`, `state`, `number_of_accounts`, `number_of_accounts_succeeded`, `state_transitions`, `billing_preview_run_number`, `file`, `include_draft_items`, `include_evergreen_subscriptions` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/bill_run_previews --header 'Content-Type: application/json' --header 'Authorization: Bearer d13fdb394bad49a596390bf54b479bc3' --data '{\n \"include_draft_items\": false,\n \"include_evergreen_subscriptions\": true,\n \"charges_excluded\": [\"one_time\", \"usage\"],\n \"target_date\": \"2023-01-01\",\n \"batches\": [\"Batch3\", \"Batch4\"],\n \"assume_renewal\": \"auto_renew_only\"\n }'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nLocalDate todayDate = LocalDate.now();\nBillRunPreviewCreateRequest billRunPreviewCreateRequest = new BillRunPreviewCreateRequest()\n .includeDraftItems(false)\n .includeEvergreenSubscriptions(true)\n .chargesExcluded(new ArrayList<>(Arrays.asList(\n BillRunPreviewCreateRequest.ChargesExcludedEnum.ONE_TIME,\n BillRunPreviewCreateRequest.ChargesExcludedEnum.USAGE)))\n .targetDate(todayDate)\n .batches(new ArrayList<>(Arrays.asList(\n \"Batch3\", \"Batch4\"\n )))\n .assumeRenewal(BillRunPreviewCreateRequest.AssumeRenewalEnum.AUTO_RENEW_ONLY);\n \nBillRunPreview billRunPreview = zuoraClient\n .billRunPreviews()\n .createBillRunPreview(billRunPreviewCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst billRunPreviewCreateRequest = {\n include_draft_items: false,\n include_evergreen_subscriptions: true,\n charges_excluded: [\"one_time\", \"usage\"],\n target_date: \"2023-01-01\",\n batches: [\"Batch3\", \"Batch4\"],\n assume_renewal: \"auto_renew_only\"\n };\n\nconst newBillRunPreview = await zuoraClient.billRunPreviews.createBillRunPreview(billRunPreviewCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/billRunPreview"
},
"example": {
"id": "8ad0934e8727f642018729728eae1b2a",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28 11:19:57",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28 11:19:46",
"assume_renewal": "auto_renew_only",
"batches": [
"Batch3",
"Batch4"
],
"charges_excluded": [
"one_time",
"usage"
],
"include_draft_items": false,
"include_evergreen_subscriptions": true,
"target_date": "2023-01-01",
"state_transitions": {
"complete_time": "2023-03-28 11:19:57",
"processing_start_time": "2023-03-28 11:19:47"
},
"file": {
"url": "8ad0962d8727efba01872972b9f235a5"
},
"billing_preview_run_number": "BPR-00000039",
"state": "completed",
"number_of_accounts_succeeded": 1,
"number_of_accounts": 1
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/query_runs/{query_run_id}": {
"get": {
"operationId": "getQueryRun",
"summary": "Retrieve a query run",
"tags": [
"Query Runs"
],
"description": "Retrieves the query run with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "query_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "query_run_id",
"required": true,
"schema": {
"type": "string"
},
"description": "query_run_id"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/query_runs/8ce80b3b-f2c8-45e2-b495-03703754dbff --header 'Authorization: Bearer cbf5f7c69105431289eee98fa13c8b83' --header 'Content-Type: application/json' "
},
{
"lang": "Java",
"label": "Java",
"source": "\nQueryRun queryRunResponse = zuoraClient.queryRuns().getQueryRun(\"8ce80b3b-f2c8-45e2-b495-03703754dbff\",null);\nSystem.out.println(queryRunResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst queryRunResponse = await zuoraClient.queryRuns.getQueryRun(\"8ce80b3b-f2c8-45e2-b495-03703754dbff\");\nconsole.log(queryRunResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryRun"
},
"example": {
"created_by_id": "47b43d42-f237-4bfa-82b5-5602e2282e3d",
"id": "8ce80b3b-f2c8-45e2-b495-03703754dbff",
"sql": "SELECT * FROM subscription",
"remaining_attempts": 3,
"updated_time": "2023-04-12T00:26:42.227Z",
"file": {
"id": "8ce80b3b-f2c8-45e2-b495-03703754dbff_1833251171549653.dsv",
"url": "https://owl-auw2-sbx01-query-result.s3.us-west-2.amazonaws.com/8ce80b3b-f2c8-45e2-b495-03703754dbff_1833251171549653.dsv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJIMEYCIQDa0aBFH4e%2FOtmrY8sNsiXxnPLClpwjzipqMFdoQ1Pa8QIhAKo4NtaMa8rxoHHh5O31b%2BvuWlxkgaibQfLl1nF8sKnaKvwDCLD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQBBoMMDQ5NzUxNzE2Nzc0Igx%2FKDjiqJmh1eRP%2FOYq0APDiPAxPWUIAZXyCa76ja6HSqH9QWVPnH%2BVcUEdww8f45l1x8naqU%2FagnKkZct8Bts30Axmeo4iinKLVnFfIfCvjJn1dXg%2FL2gRE2lg7%2BAe3HTFwcRhQivCAKqBhKrQb%2F19Ut%2BgF7vaeS9TtBq3YuItoNUnZkIcJq2UIZYSpvtf4HYuJk6txis5DFH9yzLaPPpcrJ71qF6A%2BHWyAuV%2BVwWgjLXAk1aD9teFf%2F13VvqhdU1ILkTxD8P57cEAa0Iui%2BJJIO9e5O0lk%2BzeZ1eQ3Lbe6PGOeRQcGW6Qkc8cIsXhQb04GPixqaYH1luZQ0QB0AMVH1NCh47w4uhCul8ECgFn33iwY97VHjFl%2FU4lJbTtpnR5YHkuCFps4COSs7VP%2B8y1SSpu1mfsl4OXIH9OT5Abs45sf2CkWsaCmRmfigL25XTWy7x3rsFic9lYnOVKnEj3mN99GzgM2Ms2GsV1lxV9gk8M3V1I6OBCl8o6PVQTDEsr4ZJ3Rs%2FyJg7q0pEPWXLDao4VwA3lQzvQCmvjMHJDXcFgiGkWQm%2B0WzU2cs1BM7JLs5RKUpRGLWBz%2FFvzdA1%2F0rxbE3rdBQklJwKGM6PWE0PUoh7AySU8BZLutYLOUTCrytehBjqkAd9UvURTKb8SFyWeSDwJ1uTEbW3KOBHgbmzbVyihyFJMphgHd3LBwAZoIW%2BR8o4C0BhJgdpaitRHf7GJt2cslLcrxFNNCXcdbX5PlVuphk1hybjrExpmuzjxtbQSbjHS53XwNgRnMPV3zb4macrAECWTqC5il5JlqCYRtaKxSufUZbqZecI%2BO1doJIYrUi7ItCex8WuLCy%2B7Bsm904c2CwJSMTBW&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230412T002642Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=ASIAQXFLO6OTGM4JW52F%2F20230412%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=1137ea00b89ec0f53423f7fba44ffbbe7e1051ac9dcfd0d169d3a42b6900ecd5",
"content_type": "dsv"
},
"number_of_rows": 4639,
"state": "complete",
"column_separator": ":"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/query_runs": {
"post": {
"operationId": "createQueryRun",
"summary": "Create a query run",
"tags": [
"Query Runs"
],
"description": "Creates a new query run job.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryRunCreateRequest"
},
"example": {
"sql": "SELECT * FROM subscription",
"content_type": "dsv",
"read_deleted": false,
"column_separator": ":"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "query_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "curl --request POST --url https://rest.apisandbox.zuora.com/v2/query_runs --header 'Authorization: Bearer 2875a82617584dd8b521d1a9dbda1452' --header 'Content-Type: application/json' --data '{ \"sql\": \"SELECT a.name AS account_name, sub.name AS sub_name, sub.version AS sub_version, sub.termstartdate, sub.termenddate, sub.source__c FROM subscription sub INNER JOIN account a ON sub.accountid = a.id where sub.status in ('\\''Active'\\'','\\''Cancelled'\\'') and source__c like '\\''Mark%'\\'' order by a.name, sub.name, sub.version\",\n \"content_type\": \"json\"\n}'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nQueryRunCreateRequest queryRunCreateRequest = new QueryRunCreateRequest()\n .sql(\"SELECT * FROM subscription\")\n .contentType(QueryRunCreateRequest.queryRunPostFileContentTypeEnum.DSV)\n .readDeleted(false)\n .columnSeparator(:);\n\nQueryRun newQueryRun = zuoraClient.queryRuns().createQueryRun(queryRunCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "const queryRunCreateRequest = {\n sql: \"SELECT * FROM subscription\",\n content_type: \"dsv\",\n read_deleted: false,\n column_separator: \":\"\n};\nconst newQueryRun = await zuoraClient.queryRuns.createQueryRun(queryRunCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryRun"
},
"example": {
"created_by_id": "47b43d42-f237-4bfa-82b5-5602e2282e3d",
"id": "8ce80b3b-f2c8-45e2-b495-03703754dbff",
"sql": "SELECT * FROM subscription",
"remaining_attempts": 3,
"updated_time": "2023-04-12T00:26:42.227Z",
"file": {
"id": "8ce80b3b-f2c8-45e2-b495-03703754dbff_1833251171549653.dsv",
"url": "https://owl-auw2-sbx01-query-result.s3.us-west-2.amazonaws.com/8ce80b3b-f2c8-45e2-b495-03703754dbff_1833251171549653.dsv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEMf%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLXdlc3QtMiJIMEYCIQDa0aBFH4e%2FOtmrY8sNsiXxnPLClpwjzipqMFdoQ1Pa8QIhAKo4NtaMa8rxoHHh5O31b%2BvuWlxkgaibQfLl1nF8sKnaKvwDCLD%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQBBoMMDQ5NzUxNzE2Nzc0Igx%2FKDjiqJmh1eRP%2FOYq0APDiPAxPWUIAZXyCa76ja6HSqH9QWVPnH%2BVcUEdww8f45l1x8naqU%2FagnKkZct8Bts30Axmeo4iinKLVnFfIfCvjJn1dXg%2FL2gRE2lg7%2BAe3HTFwcRhQivCAKqBhKrQb%2F19Ut%2BgF7vaeS9TtBq3YuItoNUnZkIcJq2UIZYSpvtf4HYuJk6txis5DFH9yzLaPPpcrJ71qF6A%2BHWyAuV%2BVwWgjLXAk1aD9teFf%2F13VvqhdU1ILkTxD8P57cEAa0Iui%2BJJIO9e5O0lk%2BzeZ1eQ3Lbe6PGOeRQcGW6Qkc8cIsXhQb04GPixqaYH1luZQ0QB0AMVH1NCh47w4uhCul8ECgFn33iwY97VHjFl%2FU4lJbTtpnR5YHkuCFps4COSs7VP%2B8y1SSpu1mfsl4OXIH9OT5Abs45sf2CkWsaCmRmfigL25XTWy7x3rsFic9lYnOVKnEj3mN99GzgM2Ms2GsV1lxV9gk8M3V1I6OBCl8o6PVQTDEsr4ZJ3Rs%2FyJg7q0pEPWXLDao4VwA3lQzvQCmvjMHJDXcFgiGkWQm%2B0WzU2cs1BM7JLs5RKUpRGLWBz%2FFvzdA1%2F0rxbE3rdBQklJwKGM6PWE0PUoh7AySU8BZLutYLOUTCrytehBjqkAd9UvURTKb8SFyWeSDwJ1uTEbW3KOBHgbmzbVyihyFJMphgHd3LBwAZoIW%2BR8o4C0BhJgdpaitRHf7GJt2cslLcrxFNNCXcdbX5PlVuphk1hybjrExpmuzjxtbQSbjHS53XwNgRnMPV3zb4macrAECWTqC5il5JlqCYRtaKxSufUZbqZecI%2BO1doJIYrUi7ItCex8WuLCy%2B7Bsm904c2CwJSMTBW&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230412T002642Z&X-Amz-SignedHeaders=host&X-Amz-Expires=14400&X-Amz-Credential=ASIAQXFLO6OTGM4JW52F%2F20230412%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=1137ea00b89ec0f53423f7fba44ffbbe7e1051ac9dcfd0d169d3a42b6900ecd5",
"content_type": "dsv"
},
"number_of_rows": 4639,
"state": "complete",
"column_separator": ":"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/query_runs/{query_run_id}/cancel": {
"post": {
"operationId": "cancelQueryRun",
"summary": "Cancel a query run",
"tags": [
"Query Runs"
],
"description": "Cancels a query run. This operation is only applicable if the state of the query run is `accepted` or `in_progress`.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "query_run.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `created_by_id`, `id`, `sql`, `remaining_attempts`, `updated_time`, `file`, `number_of_rows`, `processing_duration`, `state`, `column_separator` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "query_run_id",
"required": true,
"schema": {
"type": "string"
},
"description": "query_run_id"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/query_runs/cfefa1e7-61d9-4cd5-8f60-d995518e3546/cancel --header 'Authorization: Bearer cbf5f7c69105431289eee98fa13c8b83' --header 'Content-Type: application/json' "
},
{
"lang": "Java",
"label": "Java",
"source": "\nQueryRun canceledQueryRun = zuoraClient.queryRuns().cancelQueryRun(\"8ce80b3b-f2c8-45e2-b495-03703754dbff\");\nSystem.out.println(canceledQueryRun);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst canceledQueryRun = await zuoraClient.queryRuns.cancelQueryRun(\"8ce80b3b-f2c8-45e2-b495-03703754dbff\");\nconsole.log(canceledQueryRun); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/queryRun",
"example": {
"created_by_id": "47b43d42-f237-4bfa-82b5-5602e2282e3d",
"id": "94d968ba-e5d1-437a-a86f-bb7c486e8987",
"sql": "SELECT * FROM subscription",
"remaining_attempts": 3,
"updated_time": "2023-04-12T17:42:28.911Z",
"state": "cancelled"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments": {
"get": {
"operationId": "getFulfillments",
"summary": "List fulfilllments",
"tags": [
"Fulfillments"
],
"description": "Returns a dictionary with a data property that contains an array of fulfillments, starting after the cursor, if used. Each entry in the array is a separate fulfillment object. If no more fulfillment are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url 'https://rest.apisandbox.zuora.com/v2/fulfillments' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nListFulfillmentResponse fulfillmentListResponse = zuoraClient.fulfillment().getFulfillments(null,null,null,null);\nSystem.out.println(fulfillmentListResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentResponse = await zuoraClient.fulfillments.getFulfillments({\n filter: [ \n \"id.EQ:08dacd3fe8b648f6861d5eb506d02a86\"\n ]})\n \nconsole.log(fulfillmentResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/filfillmentListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createFulfillment",
"summary": "Create a fulfillment",
"tags": [
"Fulfillments"
],
"description": "Creates a new fulfillment object.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentCreateRequest"
},
"example": {
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"description": "Create a fulfillment",
"fulfillment_date": "2022-03-01",
"type": "delivery",
"quantity": 2,
"state": "booked",
"external_id": "1201",
"tracking_number": "0987",
"fulfillment_system": "Provision",
"items": [
{
"description": "Create Item",
"fulfillment_number": "F-00000021",
"fulfillment_item_number": "Item 01"
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/fulfillments --header 'Authorization: Bearer d71a4363b94f42bca6e1453892818775' --header 'Content-Type: application/json' --data '{\n \"order_line_item_id\": \"8ad085e287142db601872469b9ec0944\",\n \"description\": \"create fulfillment\",\n \"fulfillment_date\": \"2022-03-25\",\n \"type\": \"delivery\",\n \"quantity\": 2,\n \"state\": \"processing\",\n \"external_id\": \"1234\",\n \"tracking_number\": \"0987\",\n \"fulfillment_system\": \"Test System\",\n \"processing_options\": {\n \"document_date\": \"2022-03-25\",\n \"target_date\": \"2022-03-25\",\n \"collection_method\": \"create_invoice\"\n }\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillmentCreateRequest fulfillmentCreateRequest = new FulfillmentCreateRequest()\n .order_line_item_id(\"8ad085e287142db601872469b9ec0944\")\n .fulfillment_date(\"2022-03-25\")\n .type(\"delivery\");\n\nFulfillment fulfillment = zuoraClient.fulfillments().createFulfillment(fulfillmentCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentCreateRequest = {\n order_line_item_id: '8ad085e287142db601872469b9ec0944',\n fulfillment_date: '2022-03-25',\n type: 'delivery'\n};\n \nconst newFulfillment = await zuoraClient.fulfillments.createFulfillment(contactFulfillmentRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillment"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments/{fulfillment_id}": {
"get": {
"operationId": "getFulfillment",
"summary": "Retrieve a fulfillment",
"tags": [
"Fulfillments"
],
"description": "Retrieves the fulfillment with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "fulfillment_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/fulfillments/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillment fulfillmentResponse = zuoraClient.fulfillment().getFulfillment(fulfillment.getId());\nSystem.out.println(fulfillmentResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentResponse = await zuoraClient.fulfillments.getFulfillment('8ad09bce844283060184475e7ee669f0');\n \nconsole.log(fulfillmentResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillment"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-0000002001234",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"target_date": "2022-03-31",
"description": "Create a fulfillment",
"tracking_number": "09827",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updateFulfillment",
"summary": "Update a fulfillment",
"tags": [
"Fulfillments"
],
"description": "Updates the specified fulfillment by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentPatchRequest"
},
"example": {
"quantity": 5,
"state": "booked",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"tracking_number": "09828"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "fulfillment_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/fulfillments/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{\n \"quantity\": 5,\n \"state\": \"booked\",\n \"external_id\": \"0987\",\n \"tracking_number\": \"09827\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillment oldFulfillment = zuoraClient.fulfillments().getFulfillment(\"8ad0991582aa848e0182ae9dad214dd0\");\n\nFulfillmentPatchRequest fulfillmentPatchRequest = new FulfillmentPatchRequest()\n .tracking_number(\"09827\")\n .external_id(\"0987\")\n .state(\"booked\"));\n\nFulfillment updatedFulfillment = zuoraClient.fulfillments().updateFulfillment(oldFulfillment.getId(),fulfillmentPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentId = newFulfillment.id;\n\nconst fulfillmentPatchRequest = {\n\tquantity: 5,\n\tstate: \"booked\",\n\texternal_id: \"0987\",\n\ttracking_number: \"09827\"\n};\n \nconst updatedFulfillment = await zuoraClient.fulfillments.updateFulfillment(fulfillmentId, fulfillmentPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillment"
},
"example": {
"id": "8ad08d298727e378018728f2a2452b0e",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-28T09:00:42-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T09:00:02-07:00",
"custom_fields": {},
"order_line_item_id": "8ad085e287142db601872469b9ec0944",
"fulfillment_number": "F-00000020",
"fulfillment_date": "2022-03-01",
"quantity": 5,
"state": "booked",
"description": "Create a fulfillment",
"tracking_number": "09828",
"fulfillment_system": "Provision",
"external_id": "b12487f0-cd81-11ed-82b6-c9f5c53749cc",
"revenue": {
"exclude_item_billing_from_revenue_accounting": false,
"exclude_item_booking_from_revenue_accounting": false
},
"location": "Oregon"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteFulfillment",
"summary": "Delete a fulfillment",
"tags": [
"Fulfillments"
],
"description": "Permanently deletes a fulfillment. It cannot be undone.",
"parameters": [
{
"in": "path",
"name": "fulfillment_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/fulfillments/8ad08c0f7d0972ea017d0a705e8059ba' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.fulfillments().deleteFulfillment(createdFulfillment.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentDeleteResponse = await zuoraClient.fulfillments.deleteFulfillment('8ad09bce844283060184475e7ee669f0');\nconsole.log(fulfillmentDeleteResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments_items/{fulfillment_item_id}": {
"get": {
"operationId": "getFulfillmentItem",
"summary": "Retrieve a fulfillment item",
"tags": [
"Fulfillment Items"
],
"description": "Retrieves the fulfillment item with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "fulfillment_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/fulfillments_items/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillmentItem fulfillmentItemResponse = zuoraClient.fulfillmentItem().getFulfillmentItem(fulfillmentItem.getId());\nSystem.out.println(fulfillmentItemResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentItemResponse = await zuoraClient.fulfillmentItems.getFulfillmentItem('8ad09bce844283060184475e7ee669f0'); \nconsole.log(fulfillmentItemResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItem"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updateFulfillmentItem",
"summary": "Update a fulfillment item",
"tags": [
"Fulfillment Items"
],
"description": "Updates the specified fulfillment item by setting the values of the fields passed. Any fields not provided remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItemPatchRequest"
},
"example": {
"description": "Update Item Number",
"fulfillment_item_number": "Item 003"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "fulfillment_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/fulfillments_items/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{\n \"description\":\"Update Item Number\",\n \"fulfillment_item_number\": \"Item 3.1\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillmentItem oldFulfillmentItem = zuoraClient.fulfillmentItems().getFulfillmentItem(\"8ad0991582aa848e0182ae9dad214dd0\");\n\nFulfillmentItemPatchRequest fulfilmentItemPatchRequest = new FulfillmentItemPatchRequest()\n .description(Update Item Number)\n .fulfillment_item_number(\"USA\");\n\n\nFulfillmentItem updatedFulfilmentItem = zuoraClient.fulfillmentItems().updateFulfillmentItem(oldFulfillmentItem.getId(),fulfillmentItemPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentItemId = newFulfillmentItem.id;\n\nconst fulfillmentItemPatchRequest = {\n description: 'Update Item Number',\n fulfillment_item_number: 'Item 3.1'\n};\n \nconst updatedFulfillmentItem = await zuoraClient.fulfillmentItems.updateFulfillmentItems(fulfillmentItemId, PatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItem"
},
"example": {
"id": "8ad09e208727f63f01872967daf72c59",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Update Item Number",
"fulfillment_item_number": "Item 003",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"delete": {
"operationId": "deleteFulfillmentItem",
"summary": "Delete a fulfillment item",
"tags": [
"Fulfillment Items"
],
"description": "Permanently deletes a fulfillment item. This operation cannot be undone.",
"parameters": [
{
"in": "path",
"name": "fulfillment_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "ID of the fulfillment item."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "delete",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request DELETE --url 'https://rest.apisandbox.zuora.com/v2/fulfillments_items/8ad08c0f7d0972ea017d0a705e8059ba' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nSuccessResponse result = zuoraClient.fulfillmentItems().deleteFulfillmentItem(createdFulfillmentItem.getId());\nSystem.out.println(result);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentItemsDeleteResponse = await zuoraClient.fulfillmentItems.deleteFulfillmentItems('8ad09bce844283060184475e7ee669f0');\nconsole.log(fulfillmentItemsDeleteResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"204": {
"description": "Default Response",
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments_items": {
"get": {
"operationId": "getFulfillmentItems",
"summary": "List fulfillment items",
"tags": [
"Fulfillment Items"
],
"description": "Returns a dictionary with a data property that contains an array of fulfillment items, starting after the cursor, if used. Each entry in the array is a separate fulfillment item object. If no more fulfillment item are available, the resulting array will be empty. This request should never return an error.",
"parameters": [
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string",
"x-java-sdk-legacy-param": true
},
"description": "A cursor for use in pagination. A cursor defines the starting place in a list. For instance, if you make a list request and receive 100 objects, ending with `next_page=W3sib3JkZXJ=`, your subsequent call can include `cursor=W3sib3JkZXJ=` in order to fetch the next page of the list."
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "sort[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive query parameter that specifies the sort order of the list, which can be either ascending (e.g. `account_number.asc`) or descending (e.g. `account_number.desc`). You cannot sort on properties that are arrays. If the array-type properties are specified for the `sort[]` parameter, they are ignored."
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99,
"default": 30
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "list",
"x-is-list-operation": true,
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url 'https://rest.apisandbox.zuora.com/v2/fulfillments_items' --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nListFulfillmentItemResponse fulfillmentItemListResponse = zuoraClient.fulfillmentItems().getFulfillmentItems(null,null,null,null);\nSystem.out.println(fulfillmentItemsListResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentItemResponse = await zuoraClient.fulfillmentItems.getFulfillmentItems({\n filter: [ \n \"id.EQ:08dacd3fe8b648f6861d5eb506d02a86\"\n ]})\n \nconsole.log(fulfillmentItemResponse);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/filfillmentItemListResponse"
},
"example": {
"next_page": "W3sib3JkZXJCeSI6eyJmaWVsZCI6IlVwZGF0ZWREYXRlIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMjAyMi0xMi0yMFQxMjoyODo1NC0wODowMCJ9LHsib3JkZXJCeSI6eyJmaWVsZCI6IklkIiwib3JkZXIiOiJERVNDIn0sInZhbHVlIjoiMmM5MmMwZjk2YWJjMTdkZTAxNmFiZDYyYmQwYzU4NTQifV0=",
"data": [
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
},
{
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
}
]
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"post": {
"operationId": "createFulfillmentItem",
"summary": "Create a fulfillment item",
"tags": [
"Fulfillment Items"
],
"description": "Creates a new fulfillment item object.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItemCreateRequest"
},
"example": {
"description": "Create a fulfillment Item",
"fulfillment_number": "F-00000020",
"fulfillment_item_number": "Item 3"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/fulfillments_items --header 'Authorization: Bearer d71a4363b94f42bca6e1453892818775' --header 'Content-Type: application/json' --data '{\n \"description\": \"Create fulfillment item\",\n \"fulfillment_number\": \"F-00000020\",\n \"fulfillment_item_number\": \"Item 3\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nFulfillmentItemCreateRequest fulfillmentItemCreateRequest = new FulfillmentItemCreateRequest()\n .description(\"Create fulfillment item\")\n .fulfillment_number(\"F-00000020\")\n .fulfillment_item_number(\"Item 3\");\n\nFulfillmentItem fulfillmentItem = zuoraClient.fulfillmentItems().createFulfillmentItem(fulfillmentItemCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst fulfillmentItemCreateRequest = {\n description: 'Create fulfillment item',\n fulfillment_number: 'F-00000020',\n fulfillment_item_number: 'Item 3'\n};\n \nconst newFulfillmentItem = await zuoraClient.fulfillmentItems.createFulfillmentItem(fulfillmentItemCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItem"
},
"example": {
"id": "8ad08ccf8437067601843a7af4e64rq3",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-03-29T10:04:53-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-03-28T11:08:04-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"description": "Create a fullfillment item",
"fulfillment_item_number": "Item 3",
"fulfillment_id": "8ad08d298727e378018728f2a2452b0e"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments/bulk_create": {
"post": {
"operationId": "createFulfillments",
"summary": "Create fulfillments",
"tags": [
"Fulfillments"
],
"description": "Creates multiple fulfillments.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentCreateBulkRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `state`, `description`, `quantity`, `order_line_item_id`, `fulfillment_number`, `revenue`, `fulfillment_date`, `tracking_number`, `carrier`, `fulfillment_system`, `location`, `external_id`, `type`, `target_date` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "credit_memo_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `credit_memo_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `service_end`, `service_start`, `accounts_receivable_account`, `on_account_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `subtotal`, `invoice_item_id`, `document_item_date` \n "
},
{
"in": "query",
"name": "invoice_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `amount`, `booking_reference`, `applied_to_item_id`, `price_id`, `discount_item`, `deferred_revenue_account`, `description`, `invoice_id`, `sku`, `name`, `purchase_order_number`, `quantity`, `recognized_revenue_account`, `remaining_balance`, `revenue_recognition_rule_name`, `accounting_code`, `service_end`, `service_start`, `accounts_receivable_account`, `subscription_id`, `subscription_item_id`, `tax`, `tax_code`, `tax_inclusive`, `unit_amount`, `unit_of_measure`, `document_item_date` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "bulkCreate",
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentCreateBulkResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/fulfillments_items/bulk_create": {
"post": {
"operationId": "createFulfillmentItems",
"summary": "Create fulfillment items",
"tags": [
"Fulfillment Items"
],
"description": "Bulk create fulfillment items.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItemCreateBulkRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "fulfillment_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `fulfillment_id`, `description`, `fulfillment_item_number` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "bulkCreate",
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fulfillmentItemCreateBulkResponse"
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedule_items/{payment_schedule_item_id}": {
"get": {
"operationId": "getPaymentScheduleItem",
"summary": "Retrieve a payment schedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Retrieves the payment schedule item with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule item. Can be either `payment_schedule_item_id` or `payment_schedule_item_number`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/payment_schedules_items/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n "
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentScheduleItem paymentScheduleItemsResponse = zuoraClient.paymentScheduleItems().getPaymentScheduleItem(paymentScheduleItems.getId());\nSystem.out.println(paymentScheduleItemsResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentScheduleItemsResponse = await zuoraClient.paymentScheduleItems.getPaymentScheduleItem('8ad09bce844283060184475e7ee669f0'); \nconsole.log(paymentScheduleItemsResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updatePaymentScheduleItem",
"summary": "Update a payment schedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Updates the specified payment schedule item by setting the values of the parameters passed. Any parameters not provided will remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItemPatch"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule item. Can be either `payment_schedule_item_id` or `payment_schedule_item_number`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/payment_schedule_items/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{\n \"unlink\": [{\n \"id\": \"8ad0922589de70ef0189df1b78c50ff7\"\n }]\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentScheduleItem oldPaymentScheduleItem = zuoraClient.paymentScheduleItems().getPaymentScheduleItem(\"8ad0991582aa848e0182ae9dad214dd0\");\n\nPaymentScheduleItemPatchRequest paymentScheduleItemPatchRequest = new PaymentScheduleItemPatchRequest()\n .unlink(\"8ad0922589de70ef0189df1b78c50ff7\"));\n\nPaymentScheduleItem updatedPaymentScheduleItem = zuoraClient.paymentScheduleItems().updatePaymentScheduleItem(oldPaymentScheduleItem.getId(),paymentScheduleItemPatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentScheduleItemId = newPaymentScheduleItem.id;\n\nconst paymentScheduleItemPatchRequest = {\n\tunlink: [{\n\t\tid: \"8ad0922589de70ef0189df1b78c50ff7\"\n\t}]\n};\n \nconst updatedPaymentScheduleItem = await zuoraClient.paymentScheduleItems().updatePaymentScheduleItem(paymentScheduleItemId, paymentSchedulesPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedule_items": {
"post": {
"operationId": "createPaymentScheduleItem",
"summary": "Create a payment schedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Creates a new Payment Schedule Item object.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItemCreateRequest"
},
"example": {
"payment_schedule_id": "8ad0940889b71fc20189b7e8eec6416e",
"amount": 6,
"run_hour": 1,
"scheduled_date": "2023-08-02"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/payment_schedule_items --header 'Authorization: Bearer d71a4363b94f42bca6e1453892818775' --header 'Content-Type: application/json' --data '{\n \"payment_schedule_id\": \"8ad085e289e27bc80189e44803796d07\",\n \"amount\": 6,\n \"run_hour\": 1,\n \"scheduled_date\": \"2023-09-29\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentScheduleItemCreateRequest paymentScheduleItemCreateRequest = new PaymentScheduleItemCreateRequest()\n .payment_schedule_id(\"8ad085e287142db601872469b9ec0944\")\n .scheduled_date(\"2023-07-26\")\n .amount(100)\n .run_hour(1);\n\nPaymentScheduleItem paymentScheduleItem = zuoraClient.paymentScheduleItems().createPaymentScheduleItem(paymentScheduleItemCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentScheduleItemCreateRequest = {\n payment_schedule_id: '8ad085e287142db601872469b9ec0944',\n scheduled_date: '2023-07-26',\n amount: 100,\n run_hour: 1\n};\n \nconst newPaymentScheduleItem = await zuoraClient.paymentScheduleItems.createPaymentScheduleItem(paymentScheduleItemCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedule_items/{payment_schedule_item_id}/cancel": {
"post": {
"operationId": "cancelPaymentScheduleItem",
"summary": "Cancel a payment schedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Cancels the payment schedule item with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule item. Can be either `payment_schedule_item_id` or `payment_schedule_item_number`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/payment_schedule_items/8ad085e289e27bc80189e44803cb6d4e/cancel --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \n PaymentScheduleItem paymentScheduleItem = zuoraClient.paymentScheduleItems().cancelPaymentScheduleItem(\"8ad085e289e27bc80189e44803cb6d4e\", null);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst cancelPaymentScheduleItem = await zuoraClient.paymentScheduleItems.cancelPaymentScheduleItem(\"8ad085e289e27bc80189e44803cb6d4e\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem",
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedule_items/{payment_schedule_item_id}/retry": {
"post": {
"operationId": "retryPaymentScheduleItem",
"summary": "Retry a payment shedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Retries the payment schedule item with the given ID.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItemRetry"
},
"example": {
"payment_gateway_id": "2c92c0f86a8dd422016a941ee0d82c7f",
"payment_method_id": "8ad081c689de67b50189de7b15b7142a"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule item. Can be either `payment_schedule_item_id` or `payment_schedule_item_number`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST \n --url https://rest.apisandbox.zuora.com/v2/payment_schedule_items/8ad085e289e27bc80189e44803cb6d4e/retry \n --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{\n \"payment_gateway_id\": \"2c92c0f86a8dd422016a941ee0d82c7f\",\n \"payment_method_id\": \"8ad081c689de67b50189de7b15b7142a\"\n }'"
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedule_items/{payment_schedule_item_id}/skip": {
"post": {
"operationId": "skipPaymentScheduleItem",
"summary": "Skip a payment schedule item",
"tags": [
"Payment Schedule Items"
],
"description": "Skips the payment schedule item with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_item_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule item. Can be either `payment_schedule_item_id` or `payment_schedule_item_number`"
},
{
"in": "header",
"name": "zuora-track-id",
"required": false,
"description": "A custom identifier for tracking API requests. If you set a value for this header, Zuora returns the same value in the response header. This header enables you to track your API calls to assist with troubleshooting in the event of an issue. The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote (\"), or quote (').",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "async",
"required": false,
"description": "Making asynchronous requests allows you to scale your applications more efficiently by leveraging Zuora's infrastructure to enqueue and execute requests for you without blocking. These requests also use built-in retry semantics, which makes them much less likely to fail for non-deterministic reasons, even in extreme high-throughput scenarios. Meanwhile, when you send a request to one of these endpoints, you can expect to receive a response in less than 150 milliseconds and these calls are unlikely to trigger rate limit errors. If set to true, Zuora returns a 202 Accepted response, and the response body contains only a request ID.",
"schema": {
"type": "boolean"
}
},
{
"in": "header",
"name": "zuora-entity-ids",
"required": false,
"description": "An entity ID. If you have multi-entity enabled and the authorization token is valid for more than one entity, you must use this header to specify which entity to perform the operation on. If the authorization token is only valid for a single entity, or you do not have multi-entity enabled, you do not need to set this header.",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "idempotency-key",
"required": false,
"description": "Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types. This idempotency key should be a unique value, and the Zuora server identifies subsequent retries of the same request using this value. For more information, see [Idempotent Requests](https://developer.zuora.com/docs/guides/idempotent-requests/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "accept-encoding",
"required": false,
"description": "Include a `accept-encoding: gzip` header to compress responses, which can reduce the bandwidth required for a response. If specified, Zuora automatically compresses responses that contain over 1000 bytes. For more information about this header, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "content-encoding",
"required": false,
"description": "Include a `content-encoding: gzip` header to compress a request. Upload a gzipped file for the payload if you specify this header. For more information, see [Request and Response Compression](https://developer.zuora.com/docs/guides/request-and-response-compression/).",
"schema": {
"type": "string"
}
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST \n --url https://rest.apisandbox.zuora.com/v2/payment_schedule_items/8ad085e289e27bc80189e44803cb6d4e/skip \n --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{}' \n "
},
{
"lang": "Java",
"label": "Java",
"source": " \nPaymentScheduleItem paymentScheduleItem = zuoraClient.paymentScheduleItems().skipPaymentScheduleItem(\"8ad085e289e27bc80189e44803cb6d4e\");\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": " \nconst skipPaymentScheduleItem = await zuoraClient.paymentScheduleItems.skipPaymentScheduleItem(\"8ad085e289e27bc80189e44803cb6d4e\");\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleItem",
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "Payments schedule item one created",
"number_of_payments": 1,
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedules/{payment_schedule_id}": {
"get": {
"operationId": "getPaymentSchedule",
"summary": "Retrieve a payment schedule",
"tags": [
"Payment Schedules"
],
"description": "Retrieves the payment schedule with the given ID.",
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule. Can be either `payment_schedule_number` or `payment_schedule_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
},
{
"$ref": "#/components/parameters/zuora-org-ids"
}
],
"x-operation-type": "get",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request GET --url https://rest.apisandbox.zuora.com/v2/payment_schedules/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 08dacd3fe8b648f6861d5eb506d02a86' --header 'Content-Type: application/json'\n"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentSchedule paymentSchedulesResponse = zuoraClient.paymentSchedules().getPaymentSchedule(paymentSchedules.getId());\nSystem.out.println(paymentSchedulesResponse);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentSchedulesResponse = await zuoraClient.paymentSchedules.getPaymentSchedule('8ad09bce844283060184475e7ee669f0'); \nconsole.log(paymentSchedulesResponse); \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentSchedule"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "",
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
},
"patch": {
"operationId": "updatePaymentSchedule",
"summary": "Update a payment schedule",
"tags": [
"Payment Schedules"
],
"description": "Updates the specified payment schedule by setting the values of the parameters passed. Any parameters not provided will remain unchanged.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentSchedulePatchRequest"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule. Can be either `payment_schedule_number` or `payment_schedule_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "update",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request PATCH --url https://rest.apisandbox.zuora.com/v2/payment_schedule/8ad08c0f7d0972ea017d0a705e8059ba --header 'Authorization: Bearer 8e8a7aec6fa4476d97a52b52dc3cc52f' --header 'Content-Type: application/json' --data '{\n \"description\": \"update payment schedule\"\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentSchedule oldPaymentSchedule = zuoraClient.paymentSchedules().getPaymentSchedule(\"8ad0991582aa848e0182ae9dad214dd0\");\n\nPaymentSchedulePatchRequest paymentSchedulePatchRequest = new PaymentSchedulePatchRequest()\n .description(\"update payment schedule\"));\n\nPaymentSchedule updatedPaymentSchedule = zuoraClient.paymentSchedules().updatePaymentSchedule(oldPaymentSchedule.getId(),paymentSchedulePatchRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentScheduleId = newPaymentSchedule.id;\n\nconst paymentSchedulePatchRequest = {\n\tdescription: \"update payment schedule\"\n};\n \nconst updatedPaymentSchedule = await zuoraClient.paymentSchedules().updatePaymentSchedule(paymentSchedulesId, paymentSchedulesPatchRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentSchedule"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "",
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedules": {
"post": {
"operationId": "createPaymentSchedule",
"summary": "Create a payment schedule",
"tags": [
"Payment Schedules"
],
"description": "Creates a new Payment Schedule object.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleCreateRequest"
},
"example": {
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"amount": 100,
"currency": "USD",
"start_date": "2023-07-26",
"payment_method_id": "8ad09e20896d5f7f018970bbca193501",
"number_of_payments": 1,
"billing_document": {
"billing_document_number": "INV00009585",
"type": "invoice"
},
"items": [
{
"amount": 100,
"run_hour": 1,
"scheduled_date": "2023-07-26"
}
]
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "create",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/payment_schedule --header 'Authorization: Bearer d71a4363b94f42bca6e1453892818775' --header 'Content-Type: application/json' --data '{\n \"account_id\": \"8ad09e20896d5f7f018970bbca5d3508\",\n \"amount\": 100,\n \"currency\": \"USD\",\n \"start_date\": \"2023-07-26\",\n \"payment_method_id\": \"8ad09e20896d5f7f018970bbca193501\",\n \"number_of_payments\": 1,\n \"billing_document\": {\n \"billing_document_number\": \"INV00009585\",\n \"type\": \"invoice\"\n }\n }'"
},
{
"lang": "Java",
"label": "Java",
"source": "\nPaymentScheduleCreateRequest paymentScheduleCreateRequest = new PaymentScheduleCreateRequest()\n .account_id(\"8ad085e287142db601872469b9ec0944\")\n .start_date(\"2023-07-26\")\n .amount(100)\n .number_of_payments(1);\n\nPaymentSchedule paymentSchedule = zuoraClient.paymentSchedules().createPaymentSchedule(paymentScheduleCreateRequest);\n "
},
{
"lang": "JavaScript",
"label": "Node",
"source": "\nconst paymentScheduleCreateRequest = {\n account_id: '8ad085e287142db601872469b9ec0944',\n start_date: '2023-07-26',\n amount: 100,\n number_of_payments: 1\n};\n \nconst newPaymentSchedule = await zuoraClient.paymentSchedules.createPaymentSchedule(paymentScheduleCreateRequest);\n "
}
],
"x-group-parameters": true,
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentSchedule"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "",
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
},
"/payment_schedules/{payment_schedule_id}/cancel": {
"post": {
"operationId": "cancelPaymentSchedule",
"summary": "Cancel a payment schedule",
"tags": [
"Payment Schedules"
],
"description": "Cancels the payment schedule with the given ID.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentScheduleCancel"
}
}
},
"required": true
},
"parameters": [
{
"in": "query",
"name": "fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": true,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `description`, `next_payment_date`, `payment_schedule_number`, `number_of_payments`, `prepayment`, `start_date`, `run_hour`, `state`, `recent_payment_date`, `total_payments_errored`, `total_payments_processed`, `total_amount`, `debit_memo_id`, `invoice_id` \n "
},
{
"in": "query",
"name": "payment_schedule_item.fields[]",
"required": false,
"schema": {
"type": "array",
"deprecated": false,
"x-java-sdk-legacy-param": false,
"x-java-sdk-fields-param": true,
"items": {
"type": "string"
},
"example": [
"id,created_time"
]
},
"description": "Allows you to specify which fields are returned in the response. \n \n Accepted values
\n `custom_fields`, `created_by_id`, `updated_by_id`, `created_time`, `id`, `updated_time`, `account_id`, `amount`, `balance`, `currency`, `debit_memo_id`, `invoice_id`, `payment_id`, `payment_method_id`, `description`, `prepayment`, `payment_gateway_id`, `run_hour`, `state`, `scheduled_date`, `payment_schedule_item_number`, `payment_schedule_id`, `cancellation_reason`, `error_message`, `payment_option_id` \n "
},
{
"in": "query",
"name": "expand[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": true,
"items": {
"type": "string"
}
},
"description": "Allows you to expand responses by including related object information in a single call. See the [Expand responses](https://developer.zuora.com/quickstart-api/tutorial/expand-responses/) section of the Quickstart API Tutorials for detailed instructions."
},
{
"in": "query",
"name": "filter[]",
"required": false,
"schema": {
"type": "array",
"x-java-sdk-legacy-param": false,
"items": {
"type": "string"
}
},
"description": "A case-sensitive filter on the list. See the [Filter lists](https://developer.zuora.com/quickstart-api/tutorial/filter-lists/) section of the Quickstart API Tutorial for detailed instructions. \n Note that the filters on this operation are only applicable to the related objects. For example, when you are calling the \"Retrieve a billing document\" operation, you can use the `filter[]` parameter on the related objects such as `filter[]=items[account_id].EQ:8ad09e208858b5cf0188595208151c63`"
},
{
"in": "query",
"name": "page_size",
"required": false,
"schema": {
"type": "integer",
"x-java-sdk-legacy-param": false,
"minimum": 1,
"maximum": 99
},
"description": "The maximum number of results to return in a single page. If the specified `page_size` is less than 1 or greater than 99, Zuora will return a 400 error."
},
{
"in": "path",
"name": "payment_schedule_id",
"required": true,
"schema": {
"type": "string"
},
"description": "Identifier for the payment schedule. Can be either `payment_schedule_number` or `payment_schedule_id`"
},
{
"$ref": "#/components/parameters/zuora-track-id"
},
{
"$ref": "#/components/parameters/async"
},
{
"$ref": "#/components/parameters/zuora-entity-ids"
},
{
"$ref": "#/components/parameters/idempotency-key"
},
{
"$ref": "#/components/parameters/accept-encoding"
},
{
"$ref": "#/components/parameters/content-encoding"
}
],
"x-operation-type": "post",
"x-code-samples": [
{
"lang": "Curl",
"label": "cURL",
"source": "\ncurl --request POST --url https://rest.apisandbox.zuora.com/v2/payment_schedules/8ad085e289e27bc80189e44803cb6d4e/cancel --header 'Content-Type: application/json' --header 'Authorization: Bearer 2a79d716ffa44c1cb6e45fffc4047b6f' --data '{\n \"cancel_date\": \"2023-09-01\"\n }' \n "
}
],
"x-group-parameters": true,
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/paymentSchedule"
},
"example": {
"id": "8ad09e208992481b018993b265472bcb",
"updated_by_id": "2c92c0946a6dffc0016a7faab604299b",
"updated_time": "2023-07-27T09:14:46-07:00",
"created_by_id": "2c92c0946a6dffc0016a7faab604299b",
"created_time": "2023-07-26T12:34:49-07:00",
"custom_fields": {
"field__c": "custom field value"
},
"account_id": "8ad09e20896d5f7f018970bbca5d3508",
"description": "",
"payment_schedule_number": "PS-00000008",
"run_hour": 0,
"total_amount": 0,
"next_payment_date": "",
"recent_payment_date": "",
"state": "canceled",
"total_payments_errored": 0,
"total_payments_processed": 0,
"prepayment": false
}
}
},
"headers": {
"ratelimit-limit": {
"description": "The request limit quota for the time window closest to exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "string"
}
},
"ratelimit-remaining": {
"description": "The number of requests remaining in the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"ratelimit-reset": {
"description": "The number of seconds until the quota resets for the time window closest to quota exhaustion. See [rate limits](https://developer.zuora.com/rest-api/general-concepts/rate-concurrency-limits/#rate-limits) for more information.",
"schema": {
"type": "number"
}
},
"zuora-request-id": {
"description": "Zuora’s internal identifier for this request.",
"schema": {
"type": "string"
}
},
"zuora-track-id": {
"description": "A user-supplied identifier for this request. If you supply a `zuora-track-id` as a request header, Zuora returns the `zuora-track-id` as a response header. ",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Request",
"example": {
"type": "bad_request",
"errors": [
{
"code": "invalid_parameter",
"parameter": "currency",
"message": "'currency' length must be between 3 and 3"
}
],
"retryable": false
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Unauthorized",
"example": {
"type": "unauthorized",
"errors": [],
"retryable": false
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Not Found",
"example": {
"type": "not_found",
"errors": [
{
"code": "resource_not_found",
"parameter": "id",
"message": "Resource 2c92c0f974e9737a0175034cc0cc10c could not be found"
}
],
"retryable": false
}
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Method Not Allowed",
"example": {
"type": "method_not_allowed",
"retryable": false,
"errors": []
}
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Too Many Requests",
"example": {
"type": "too_many_requests",
"errors": []
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Internal Server Error",
"example": {
"type": "internal_server_error",
"errors": []
}
}
}
}
},
"502": {
"description": "Bad Gateway",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Bad Gateway",
"example": {
"type": "bad_gateway",
"errors": []
}
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Service Unavailable",
"example": {
"type": "service_unavailable",
"errors": []
}
}
}
}
},
"504": {
"description": "Gateway Timeout",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorResponse",
"description": "Gateway Timeout",
"example": {
"type": "gateway_timeout",
"errors": []
}
}
}
}
}
}
}
}
},
"servers": [
{
"description": "US Developer & Central Sandbox (incl. Test Drive)",
"url": "https://rest.test.zuora.com/v2"
},
{
"description": "US API Sandbox Cloud 1",
"url": "https://rest.sandbox.na.zuora.com/v2"
},
{
"description": "US API Sandbox Cloud 2",
"url": "https://rest.apisandbox.zuora.com/v2"
},
{
"description": "US Production Cloud 1",
"url": "https://rest.na.zuora.com/v2"
},
{
"description": "US Production Cloud 2",
"url": "https://rest.zuora.com/v2"
},
{
"description": "EU Developer & Central Sandbox",
"url": "https://rest.test.eu.zuora.com/v2"
},
{
"description": "EU API Sandbox",
"url": "https://rest.sandbox.eu.zuora.com/v2"
},
{
"description": "EU Production",
"url": "https://rest.eu.zuora.com/v2"
},
{
"url": "https://rest.test.ap.zuora.com/v2",
"description": "APAC Developer & Central Sandbox"
},
{
"url": "https://rest.ap.zuora.com/v2",
"description": "APAC Production"
}
],
"security": [
{
"bearerAuth": []
}
],
"tags": [
{
"name": "Accounts",
"description": "This object represents your customer. It lets you create recurring charges and track payments that belong to the same customer."
},
{
"name": "Contacts",
"description": "Contacts represent your customer's contact details."
},
{
"name": "Custom Objects",
"description": "Zuora Custom Objects provides a uniform custom data service for you to manage custom objects in Zuora. Those custom data is stored on Zuora's platform and can be used to extend the data model to accommodate your specific use cases. "
},
{
"name": "Orders",
"description": "The Orders operations enable you to create or make modifications to subscriptions in a batch."
},
{
"name": "Order Line Items",
"description": "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.
With the Order Line Items feature enabled, you have the ability to launch non-subscription and unified monetization business models in Zuora, in addition to subscription business models."
},
{
"name": "Subscriptions",
"description": "Subscriptions allow you to charge a customer on a recurring basis, such as a monthly charge or a charge based on usage and must be associated with an Account object. Subscriptions can also include one-time charges, such as service activation fees."
},
{
"name": "Subscription Plans",
"description": "A subscription plan is part of a subscription or an amendment to a subscription, and it comes from a price. Like a product and its plans, a subscription can have one or more subscription plans. Subscription plans represent a price or a collection of prices for a service you sell. An individual subscription plan contains all prices specific to a particular subscription."
},
{
"name": "Subscription Items",
"description": "A subscription item is a part of a subscription plan, and it comes from a price."
},
{
"name": "Fulfillments",
"description": "Fulfillments are subordinate objects attached to their related order line item. You can manage the entire order line item lifecycle through fulfillments in the following ways:
- Create and attach fulfillments to an order line item to track the shipment or return status.
- Trigger billing based on the fulfillment state and generate billing documents based on the fulfillments accordingly.
- Create and attach fulfillment items to a fulfillment to keep track of all the assets in your system.
"
},
{
"name": "Fulfillment Items",
"description": "Fulfillment items are subordinate objects attached to their related fulfillment."
},
{
"name": "Bill Runs",
"description": "Bill runs automatically create invoices for your customers on a set schedule, as well as create invoices for your customers, as needed. A bill run gathers information from one or more customer accounts and generates invoices for those accounts. The operations in this section allows you to create, update, get, or delete bill runs."
},
{
"name": "Bill Run Previews",
"description": "The Bill Run Previews operations allow you to generates a preview of future billing document items for a batch of accounts through a bill run. A bill run preivew job also generates a downloadable CSV file containing a preview of invoice item data for the customer account batch."
},
{
"name": "Billing Documents",
"description": " **Note: The API operations in this section have been deprecated.** Billing Documents represent your customer's invoices, credit memos and debit memos. Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription. They contain invoice items, and proration adjustments that may be caused by changes to a subscription. If your invoice is configured to be charged automatically, Zuora automatically finalizes your invoice and attempts payment otherwise Zuora will email the invoice to your customer and await payment. Any customer credit memos may be applied before determining the amount due for the invoice (i.e., the amount that will be charged).
"
},
{
"name": "Billing Document Items",
"description": " **The API operations in this section have been deprecated.** Billing document items represent each item in your customer's invoices, credit memos, or debit memos.
"
},
{
"name": "Invoices",
"description": "Invoices are statements of amounts owed by a customer and are usually generated by a [bill run](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/J_Billing_Operations/G_Bill_Runs/Create_bill_runs). For more information about invoices, see [Invoices](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Payments/IA_Invoices/A1_Invoice_Introduction)."
},
{
"name": "Credit Memos",
"description": "Credit memos reduce invoice and account balances. By applying one or more credit memos to invoices with positive balances, you can reduce the invoice balances in the same way as applying a payment to an invoice. For more information about credit memos, see [Credit and debit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos)."
},
{
"name": "Debit Memos",
"description": "Debit memos increase the amount a customer owes. Debit memos can be used to correct undercharging on an invoice or to levy ad hoc charges outside the context of a subscription. Just like an invoice, debit memo balances can be settled by applying either a payment or a credit memo. For more information about debit memos, see [Credit and debit memos](https://knowledgecenter.zuora.com/Billing/Billing_and_Payments/Invoice_Settlement/B_Credit_and_Debit_Memos)."
},
{
"name": "Taxation Items",
"description": "The TaxationItem object is used to add a tax amount to an invoice item. Z-Tax and third-party tax engines such as Avalara or Connect tax engine can create TaxationItem objects. Before you use the Taxation Item object, you have to configure Z-Tax, Avalara, or Connect tax engine, as the object's fields rely on the values you create during the configuration process."
},
{
"name": "Usage Records",
"description": "The operations in this section allows you to create, update, get, or delete usage records. Zuora expects no more than 25 million usage records per month. If you want to go over this limit, contact your Zuora account manager for further consultation."
},
{
"name": "Payment Methods",
"description": "Payment methods represent your customer's payment instruments. They can be used to collect payments or saved to Account objects to store instrument details for future payments.\n\n**Important**: The `type` field in the request body schema of the [Create a payment method](https://developer.zuora.com/other-api/quickstart-api/operation/createPaymentMethod/) operation enumerates the supported payment methods. Not all payment gateways support all these payment method types. Check Supported payment methods to check the supported payment methods for each gateway.\n \nIf you need to create payment methods outside the scope of this operaton, you have to use the [Create a payment method](https://developer.zuora.com/v1-api-reference/api/operation/POST_PaymentMethods/) operation of the v1 API instead of the Quickstart API. \nWe do not plan to add additional payment methods to the Quickstart API. Any new payment methods will only be available through the v1 API and Zuora client libraries."
},
{
"name": "Payments",
"description": "Payments represents a customer payment. The Payment object holds all of the information about a payment, including the payment amount and which billing documents the payment is applied to."
},
{
"name": "Payment Runs",
"description": "Payment runs are used to collect payments using electronic payment methods. Even if a payment was made to an invoice but had an error, if an invoice has a positive balance and meets all the filter criteria for the payment run, Zuora will pick up the invoice for processing in the payment run.
Zuora supports two type of payment runs: ad hoc and recurring. These are similar to ad hoc and scheduled bill runs"
},
{
"name": "Payment Schedules",
"description": "The Payment Schedules feature enables you to collect a series of payments following customized timelines and rules. You have the flexibility to leverage a payment schedule to process either a single payment or multiple payments.
You can leverage this feature to split invoice or account balances into several installments, and then automatically process payments for the installments. Payment schedules can also be used to collect external payments made for the installments. Meanwhile, we’ve provided you the capability to easily manage and modify existing schedules, as well as to manually retry failed payments with updated configurations."
},
{
"name": "Payment Schedule Items",
"description": "A payment schedule consists of one or more payment schedule items that can be picked up by payment runs, which are hourly scheduled by Zuora. Each payment schedule item will trigger a payment process."
},
{
"name": "Refunds",
"description": "A refund returns money to a customer. For instance, refunds are used when a customer cancels service and is no longer your customer. The Quickstart API allows you to refund payments, update refunds, and get refunds."
},
{
"name": "Products",
"description": "Products describe the specific goods or services you offer to your customers and help you track inventory or provisioning. They should be used in conjunction with Plans and Prices to configure pricing."
},
{
"name": "Plans",
"description": "Plans are collections of Prices which define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of Products. While Products help you track inventory or provisioning, plans and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing and billing cycle options should be represented by prices grouped together in a plan. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single ''Gold'' product that has prices for $100/month, $1000/year, and $50 once with the alternative billing cycle and pricing options each represented by a different plan and the recurring and one-time prices represented by different prices."
},
{
"name": "Prices",
"description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and plans and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme. For example, you might have a single ''Gold'' product that has prices for $100/month, $1000/year, and $50 once."
},
{
"name": "Workflows",
"description": "Run a specified workflow. In the request body, you can include parameters that you want to pass to the workflow. For the parameters to be recognized and picked up by tasks in the workflow, you need to define the parameters first."
},
{
"name": "Query Runs",
"description": "The Query Runs operations allow you to create, retrieve, or cancel a Data Query job run."
}
],
"x-tagGroups": [
{
"name": "PRODUCTS",
"tags": [
"Products",
"Plans",
"Prices"
]
},
{
"name": "CUSTOMER ACCOUNTS",
"tags": [
"Accounts",
"Contacts"
]
},
{
"name": "ORDERS AND SUBSCRIPTIONS",
"tags": [
"Orders",
"Order Line Items",
"Subscriptions",
"Subscription Plans",
"Subscription Items",
"Fulfillments",
"Fulfillment Items"
]
},
{
"name": "BILLING DOCUMENTS",
"tags": [
"Invoices",
"Credit Memos",
"Debit Memos"
]
},
{
"name": "BILL RUNS",
"tags": [
"Bill Runs",
"Bill Run Previews"
]
},
{
"name": "TAX",
"tags": [
"Taxation Items"
]
},
{
"name": "USAGE",
"tags": [
"Usage Records"
]
},
{
"name": "PAYMENTS",
"tags": [
"Payment Methods",
"Payments",
"Payment Runs",
"Payment Schedules",
"Payment Schedule Items",
"Refunds"
]
},
{
"name": "PLATFORM",
"tags": [
"Custom Objects",
"Query Runs",
"Workflows"
]
},
{
"name": "DEPRECATED",
"tags": [
"Billing Documents",
"Billing Document Items"
]
}
]
}