{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:zuora/get-charge-metrics":{"get":{"operationId":"finance_zuora_get_charge_metrics","summary":"List charge metrics by time range","description":"GET /charge-metrics/data/charge-metrics","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"fromTimestamp","in":"query","required":true,"description":"The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…","schema":{"type":"string","description":"The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…"}},{"name":"toTimestamp","in":"query","required":true,"description":"The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…","schema":{"type":"string","description":"The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-charge-metrics-discount-allocation-details":{"get":{"operationId":"finance_zuora_get_charge_metrics_discount_allocation_details","summary":"List discount allocation details by time range","description":"GET /charge-metrics/data/charge-metrics-discount-allocation-detail","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"fromTimestamp","in":"query","required":true,"description":"The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…","schema":{"type":"string","description":"The starting date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…"}},{"name":"toTimestamp","in":"query","required":true,"description":"The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…","schema":{"type":"string","description":"The end date and time of a time range when changes are made to charge metrics, in `yyyy-mm-ddThh:mm:ssZ` format. For example,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-event-triggers":{"get":{"operationId":"finance_zuora_get_event_triggers","summary":"List event triggers","description":"GET /events/event-triggers","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"baseObject","in":"query","required":false,"description":"The Zuora object that trigger condition is defined upon. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$","schema":{"type":"string","description":"The Zuora object that trigger condition is defined upon. Should be specified in the pattern: ^[A-Z][\\\\w\\\\-]*$"}},{"name":"eventTypeName","in":"query","required":false,"description":"The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$","schema":{"type":"string","description":"The event type name. Should be specified in the pattern: ^[A-Za-z]{1,}[\\w\\-]*$"}},{"name":"active","in":"query","required":false,"description":"The status of the event trigger.","schema":{"type":"string","description":"The status of the event trigger."}},{"name":"start","in":"query","required":false,"description":"The first index of the query result. Default to 0 if absent, and the minimum is 0.","schema":{"type":"integer","default":0,"description":"The first index of the query result. Default to 0 if absent, and the minimum is 0."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of data records to be returned. Default to 10 if absent.","schema":{"type":"integer","default":10,"description":"The maximum number of data records to be returned. Default to 10 if absent."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-event-trigger":{"post":{"operationId":"finance_zuora_post_event_trigger","summary":"Create an event trigger","description":"POST /events/event-triggers","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-event-trigger":{"get":{"operationId":"finance_zuora_get_event_trigger","summary":"Retrieve an event trigger","description":"GET /events/event-triggers/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-event-trigger":{"post":{"operationId":"finance_zuora_put_event_trigger","summary":"Update an event trigger","description":"PUT /events/event-triggers/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-event-trigger":{"post":{"operationId":"finance_zuora_delete_event_trigger","summary":"Delete an event trigger","description":"DELETE /events/event-triggers/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-query-email-templates":{"get":{"operationId":"finance_zuora_get_query_email_templates","summary":"List email templates","description":"GET /notifications/email-templates","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"start","in":"query","required":false,"description":"The first index of the query result.","schema":{"type":"integer","default":1,"description":"The first index of the query result."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results the query should return.","schema":{"type":"integer","default":20,"description":"The maximum number of results the query should return."}},{"name":"eventTypeName","in":"query","required":false,"description":"The name of the event.","schema":{"type":"string","description":"The name of the event."}},{"name":"name","in":"query","required":false,"description":"The name of the email template.","schema":{"type":"string","description":"The name of the email template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-email-template":{"post":{"operationId":"finance_zuora_post_create_email_template","summary":"Create an email template","description":"POST /notifications/email-templates","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-get-email-template":{"get":{"operationId":"finance_zuora_get_get_email_template","summary":"Retrieve an email template","description":"GET /notifications/email-templates/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"id","in":"query","required":true,"description":"The ID of the email template.","schema":{"type":"string","description":"The ID of the email template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-email-template":{"post":{"operationId":"finance_zuora_put_update_email_template","summary":"Update an email template","description":"PUT /notifications/email-templates/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The ID of the email template to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-delete-email-template":{"post":{"operationId":"finance_zuora_delete_delete_email_template","summary":"Delete an email template","description":"DELETE /notifications/email-templates/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The ID of the email template to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-delete-notification-history-for-account":{"post":{"operationId":"finance_zuora_delete_delete_notification_history_for_account","summary":"Delete notification histories for an account","description":"DELETE /notifications/history","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accountId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"accountId":{"type":"string","description":"The ID of the account whose notification histories are to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-get-notification-history-deletion-task":{"get":{"operationId":"finance_zuora_get_get_notification_history_deletion_task","summary":"Retrieve a notification history deletion task","description":"GET /notifications/history/tasks/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"id","in":"query","required":true,"description":"The ID of the notification history deletion task. You can get the deletion task ID from the 202 response body of the [Delete notification…","schema":{"type":"string","description":"The ID of the notification history deletion task. You can get the deletion task ID from the 202 response body of the [Delete notification…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-query-notification-definitions":{"get":{"operationId":"finance_zuora_get_query_notification_definitions","summary":"List notification definitions","description":"GET /notifications/notification-definitions","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"start","in":"query","required":false,"description":"The first index of the query result.","schema":{"type":"integer","default":1,"description":"The first index of the query result."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results the query should return.","schema":{"type":"integer","default":20,"description":"The maximum number of results the query should return."}},{"name":"profileId","in":"query","required":false,"description":"Id of the profile.","schema":{"type":"string","description":"Id of the profile."}},{"name":"eventTypeName","in":"query","required":false,"description":"The name of the event.","schema":{"type":"string","description":"The name of the event."}},{"name":"emailTemplateId","in":"query","required":false,"description":"The ID of the email template.","schema":{"type":"string","description":"The ID of the email template."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-notification-definition":{"post":{"operationId":"finance_zuora_post_create_notification_definition","summary":"Create a notification definition","description":"POST /notifications/notification-definitions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-get-notification-definition":{"get":{"operationId":"finance_zuora_get_get_notification_definition","summary":"Retrieve a notification definition","description":"GET /notifications/notification-definitions/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"id","in":"query","required":true,"description":"The ID of the notification definition.","schema":{"type":"string","description":"The ID of the notification definition."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-notification-definition":{"post":{"operationId":"finance_zuora_put_update_notification_definition","summary":"Update a notification definition","description":"PUT /notifications/notification-definitions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The ID of the notification definition to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-delete-notification-definition":{"post":{"operationId":"finance_zuora_delete_delete_notification_definition","summary":"Delete a notification definition","description":"DELETE /notifications/notification-definitions/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The ID of the notification definition to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/create-token":{"post":{"operationId":"finance_zuora_create_token","summary":"Create an OAuth token","description":"POST /oauth/token","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-custom-object-records-batch-update-or-delete":{"post":{"operationId":"finance_zuora_post_custom_object_records_batch_update_or_delete","summary":"Update or delete custom object records","description":"POST /objects/batch/default/{object}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-custom-object-definitions-in-namespace":{"get":{"operationId":"finance_zuora_get_all_custom_object_definitions_in_namespace","summary":"List custom object definitions","description":"GET /objects/definitions/default","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"select","in":"query","required":false,"description":"If you set `select` to `type`, the response will only contain the `type` of each custom object.","schema":{"type":"string","enum":["type"],"description":"If you set `select` to `type`, the response will only contain the `type` of each custom object."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-custom-object-definitions":{"post":{"operationId":"finance_zuora_post_custom_object_definitions","summary":"Create custom object definitions","description":"POST /objects/definitions/default","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-custom-object-definition-by-type":{"get":{"operationId":"finance_zuora_get_custom_object_definition_by_type","summary":"Retrieve a custom object definition","description":"GET /objects/definitions/default/{object}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"object","in":"query","required":true,"description":"Specifies the custom object's API name as object. It is case-sensitive.","schema":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-custom-object-definition-by-type":{"post":{"operationId":"finance_zuora_delete_custom_object_definition_by_type","summary":"Delete a custom object definition","description":"DELETE /objects/definitions/default/{object}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-custom-object-bulk-jobs":{"get":{"operationId":"finance_zuora_get_all_custom_object_bulk_jobs","summary":"List all custom object bulk jobs","description":"GET /objects/jobs","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"pageSize","in":"query","required":false,"description":"Page size of the result. The maximum page size is 100. The defaut page size is 25.","schema":{"type":"integer","description":"Page size of the result. The maximum page size is 100. The defaut page size is 25."}},{"name":"cursor","in":"query","required":false,"description":"The `cursor` points to the last job of the previous result set. The cursor job is not included in this query result. The call returns the…","schema":{"type":"string","description":"The `cursor` points to the last job of the previous result set. The cursor job is not included in this query result. The call returns the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-custom-object-bulk-job":{"post":{"operationId":"finance_zuora_post_custom_object_bulk_job","summary":"Submit a custom object bulk job","description":"POST /objects/jobs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-custom-object-bulk-job":{"get":{"operationId":"finance_zuora_get_custom_object_bulk_job","summary":"Retrieve a custom object bulk job","description":"GET /objects/jobs/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"id","in":"query","required":true,"description":"The ID of the custom object bulk job to be retrieved.","schema":{"type":"string","description":"The ID of the custom object bulk job to be retrieved."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-custom-object-bulk-job-errors":{"get":{"operationId":"finance_zuora_get_custom_object_bulk_job_errors","summary":"List all errors for a custom object bulk job","description":"GET /objects/jobs/{id}/errors","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"id","in":"query","required":true,"description":"The ID of the custom object bulk job that you retrieve errors for.","schema":{"type":"string","description":"The ID of the custom object bulk job that you retrieve errors for."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-upload-file-for-custom-object-bulk-job":{"post":{"operationId":"finance_zuora_post_upload_file_for_custom_object_bulk_job","summary":"Upload a file for a custom object bulk job","description":"POST /objects/jobs/{id}/files","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"id":{"type":"string","description":"The ID of the custom object bulk job that the file is uploaded to."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-update-custom-object-definition":{"post":{"operationId":"finance_zuora_post_update_custom_object_definition","summary":"Update a custom object definition","description":"POST /objects/migrations","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-records-for-custom-object-type":{"get":{"operationId":"finance_zuora_get_all_records_for_custom_object_type","summary":"List records for a custom object","description":"GET /objects/records/default/{object}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"object","in":"query","required":true,"description":"Specifies the custom object's API name as object. It is case-sensitive.","schema":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."}},{"name":"q","in":"query","required":false,"description":"The query string to filter the records of a custom object. See the [Query syntax of custom object…","schema":{"type":"string","description":"The query string to filter the records of a custom object. See the [Query syntax of custom object…"}},{"name":"ids","in":"query","required":false,"description":"UUIDs of the records to be queried. For example: `GET…","schema":{"type":"string","description":"UUIDs of the records to be queried. For example: `GET…"}},{"name":"pageSize","in":"query","required":false,"description":"Page size. The value must be between 1 and 1000.","schema":{"type":"integer","description":"Page size. The value must be between 1 and 1000."}},{"name":"cursor","in":"query","required":false,"description":"The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns…","schema":{"type":"string","description":"The `cursor` points to the last record of the previous result set. The cursor record is not included in the query result. The call returns…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-custom-object-records":{"post":{"operationId":"finance_zuora_post_custom_object_records","summary":"Create custom object records","description":"POST /objects/records/default/{object}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-custom-object-record-by-id":{"get":{"operationId":"finance_zuora_get_custom_object_record_by_id","summary":"Retrieve a custom object record","description":"GET /objects/records/default/{object}/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Version","in":"query","required":false,"description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…","schema":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"}},{"name":"object","in":"query","required":true,"description":"Specifies the custom object's API name as object. It is case-sensitive.","schema":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."}},{"name":"id","in":"query","required":true,"description":"Id identifier in uuid form","schema":{"type":"string","description":"Id identifier in uuid form"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-custom-object-record":{"post":{"operationId":"finance_zuora_put_custom_object_record","summary":"Update a custom object record","description":"PUT /objects/records/default/{object}/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object","id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"If-Match":{"type":"string","description":"The expected ETag of the resource. You can use this header to perform a conditional request. Zuora responds with 412 Precondition Failed…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."},"id":{"type":"string","description":"Id identifier in uuid form"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/patch-partial-update-custom-object-record":{"post":{"operationId":"finance_zuora_patch_partial_update_custom_object_record","summary":"Partially update a custom object record","description":"PATCH /objects/records/default/{object}/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object","id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."},"id":{"type":"string","description":"Id identifier in uuid form"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-custom-object-record-by-id":{"post":{"operationId":"finance_zuora_delete_custom_object_record_by_id","summary":"Delete a custom object record","description":"DELETE /objects/records/default/{object}/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["object","id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Version":{"type":"string","description":"API version that determines the response schema. The default version is used if this parameter is not included. Specify `Zuora-Version` in…"},"object":{"type":"string","description":"Specifies the custom object's API name as object. It is case-sensitive."},"id":{"type":"string","description":"Id identifier in uuid form"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-data-query-jobs":{"get":{"operationId":"finance_zuora_get_data_query_jobs","summary":"List data query jobs","description":"GET /query/jobs","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"queryStatus","in":"query","required":false,"description":"Filters the list of query jobs by status.","schema":{"type":"string","enum":["accepted","in_progress","completed","failed","cancelled"],"description":"Filters the list of query jobs by status."}},{"name":"pageSize","in":"query","required":false,"description":"Specifies the maximum number of query jobs to return.","schema":{"type":"integer","default":20,"description":"Specifies the maximum number of query jobs to return."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-data-query-job":{"post":{"operationId":"finance_zuora_post_data_query_job","summary":"Submit a data query","description":"POST /query/jobs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-data-query-job":{"get":{"operationId":"finance_zuora_get_data_query_job","summary":"Retrieve a data query job","description":"GET /query/jobs/{job-id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"job-id","in":"query","required":true,"description":"Internal identifier of the query job.","schema":{"type":"string","description":"Internal identifier of the query job."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-data-query-job":{"post":{"operationId":"finance_zuora_delete_data_query_job","summary":"Cancel a data query job","description":"DELETE /query/jobs/{job-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["job-id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"job-id":{"type":"string","description":"Internal identifier of the query job."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-process-settings-batch-request":{"post":{"operationId":"finance_zuora_post_process_settings_batch_request","summary":"Submit settings requests","description":"POST /settings/batch-requests","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-list-all-settings":{"get":{"operationId":"finance_zuora_get_list_all_settings","summary":"List all settings","description":"GET /settings/listing","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-accounting-codes":{"get":{"operationId":"finance_zuora_get_all_accounting_codes","summary":"List all accounting codes","description":"GET /v1/accounting-codes","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":300,"description":"Number of rows returned per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-accounting-code":{"post":{"operationId":"finance_zuora_post_accounting_code","summary":"Create an accounting code","description":"POST /v1/accounting-codes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-accounting-code":{"get":{"operationId":"finance_zuora_get_accounting_code","summary":"Retrieve an accounting code","description":"GET /v1/accounting-codes/{ac-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"ac-id","in":"query","required":true,"description":"ID of the accounting code you want to query.","schema":{"type":"string","description":"ID of the accounting code you want to query."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-accounting-code":{"post":{"operationId":"finance_zuora_put_accounting_code","summary":"Update an accounting code","description":"PUT /v1/accounting-codes/{ac-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ac-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ac-id":{"type":"string","description":"ID of the accounting code you want to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-accounting-code":{"post":{"operationId":"finance_zuora_delete_accounting_code","summary":"Delete an accounting code","description":"DELETE /v1/accounting-codes/{ac-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ac-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ac-id":{"type":"string","description":"ID of the accounting code you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-activate-accounting-code":{"post":{"operationId":"finance_zuora_put_activate_accounting_code","summary":"Activate an accounting code","description":"PUT /v1/accounting-codes/{ac-id}/activate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ac-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ac-id":{"type":"string","description":"ID of the accounting code you want to activate."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-deactivate-accounting-code":{"post":{"operationId":"finance_zuora_put_deactivate_accounting_code","summary":"Deactivate an accounting code","description":"PUT /v1/accounting-codes/{ac-id}/deactivate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ac-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ac-id":{"type":"string","description":"ID of the accounting code you want to deactivate."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-accounting-periods":{"get":{"operationId":"finance_zuora_get_all_accounting_periods","summary":"List all accounting periods","description":"GET /v1/accounting-periods","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":300,"description":"Number of rows returned per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-accounting-period":{"post":{"operationId":"finance_zuora_post_accounting_period","summary":"Create an accounting period","description":"POST /v1/accounting-periods","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-accounting-period":{"get":{"operationId":"finance_zuora_get_accounting_period","summary":"Retrieve an accounting period","description":"GET /v1/accounting-periods/{ap-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"ap-id","in":"query","required":true,"description":"ID of the accounting period you want to get.","schema":{"type":"string","description":"ID of the accounting period you want to get."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-accounting-period":{"post":{"operationId":"finance_zuora_put_update_accounting_period","summary":"Update an accounting period","description":"PUT /v1/accounting-periods/{ap-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period you want to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-accounting-period":{"post":{"operationId":"finance_zuora_delete_accounting_period","summary":"Delete an accounting period","description":"DELETE /v1/accounting-periods/{ap-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period you want to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-close-accounting-period":{"post":{"operationId":"finance_zuora_put_close_accounting_period","summary":"Close an accounting period","description":"PUT /v1/accounting-periods/{ap-id}/close","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period you want to close."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-pending-close-accounting-period":{"post":{"operationId":"finance_zuora_put_pending_close_accounting_period","summary":"Set an accounting period to pending close","description":"PUT /v1/accounting-periods/{ap-id}/pending-close","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period you want to set to pending close."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-reopen-accounting-period":{"post":{"operationId":"finance_zuora_put_reopen_accounting_period","summary":"Reopen an accounting period","description":"PUT /v1/accounting-periods/{ap-id}/reopen","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period that you want to re-open."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-run-trial-balance":{"post":{"operationId":"finance_zuora_put_run_trial_balance","summary":"Run trial balance","description":"PUT /v1/accounting-periods/{ap-id}/run-trial-balance","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ap-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"ap-id":{"type":"string","description":"ID of the accounting period for which you want to run a trial balance."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-account":{"post":{"operationId":"finance_zuora_post_account","summary":"Create an account","description":"POST /v1/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-billing-document-files-deletion-job":{"post":{"operationId":"finance_zuora_post_billing_document_files_deletion_job","summary":"Create a job to hard delete billing document files","description":"POST /v1/accounts/billing-documents/files/deletion-jobs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-billing-document-files-deletion-job":{"get":{"operationId":"finance_zuora_get_billing_document_files_deletion_job","summary":"Retrieve a job of hard deleting billing document files","description":"GET /v1/accounts/billing-documents/files/deletion-jobs/{jobId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"jobId","in":"query","required":true,"description":"The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c.","schema":{"type":"string","description":"The unique ID of a billing document file deletion job. For example, 2c92c8f83dc4f752013dc72c24ee016c."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-account":{"get":{"operationId":"finance_zuora_get_account","summary":"Retrieve an account","description":"GET /v1/accounts/{account-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"account-key","in":"query","required":true,"description":"Account number or account ID.","schema":{"type":"string","description":"Account number or account ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-account":{"post":{"operationId":"finance_zuora_put_account","summary":"Update an account","description":"PUT /v1/accounts/{account-key}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"account-key":{"type":"string","description":"Account number or account ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-account-summary":{"get":{"operationId":"finance_zuora_get_account_summary","summary":"Retrieve an account summary","description":"GET /v1/accounts/{account-key}/summary","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"account-key","in":"query","required":true,"description":"Account number or account ID.","schema":{"type":"string","description":"Account number or account ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-generate-billing-documents":{"post":{"operationId":"finance_zuora_post_generate_billing_documents","summary":"Generate billing documents by account ID","description":"POST /v1/accounts/{id}/billing-documents/generate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The ID of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postamend":{"post":{"operationId":"finance_zuora_action_postamend","summary":"Amend","description":"POST /v1/action/amend","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postcreate":{"post":{"operationId":"finance_zuora_action_postcreate","summary":"Create","description":"POST /v1/action/create","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postdelete":{"post":{"operationId":"finance_zuora_action_postdelete","summary":"Delete","description":"POST /v1/action/delete","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postexecute":{"post":{"operationId":"finance_zuora_action_postexecute","summary":"Execute","description":"POST /v1/action/execute","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postgenerate":{"post":{"operationId":"finance_zuora_action_postgenerate","summary":"Generate","description":"POST /v1/action/generate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postquery":{"post":{"operationId":"finance_zuora_action_postquery","summary":"Query","description":"POST /v1/action/query","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postquery-more":{"post":{"operationId":"finance_zuora_action_postquery_more","summary":"QueryMore","description":"POST /v1/action/queryMore","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postsubscribe":{"post":{"operationId":"finance_zuora_action_postsubscribe","summary":"Subscribe","description":"POST /v1/action/subscribe","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/action-postupdate":{"post":{"operationId":"finance_zuora_action_postupdate","summary":"Update","description":"POST /v1/action/update","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-amendments-by-subscription-id":{"get":{"operationId":"finance_zuora_get_amendments_by_subscription_id","summary":"List all amendments of a subscription","description":"GET /v1/amendments/subscriptions/{subscription-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"subscription-id","in":"query","required":true,"description":"The ID of the subscription whose amendment changes you want to retrieve.","schema":{"type":"string","description":"The ID of the subscription whose amendment changes you want to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-amendments-by-key":{"get":{"operationId":"finance_zuora_get_amendments_by_key","summary":"Retrieve an amendment","description":"GET /v1/amendments/{amendment-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"amendment-key","in":"query","required":true,"description":"Can be the amendment ID or the amendment code.","schema":{"type":"string","description":"Can be the amendment ID or the amendment code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-job-status-and-response":{"get":{"operationId":"finance_zuora_get_job_status_and_response","summary":"Retrieve the status and response of a job","description":"GET /v1/async-jobs/{jobId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"jobId","in":"query","required":true,"description":"UUID of the asynchronous job created by an asynchronous API operation.","schema":{"type":"string","description":"UUID of the asynchronous job created by an asynchronous API operation."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-order-asynchronously":{"post":{"operationId":"finance_zuora_post_create_order_asynchronously","summary":"Create an order asynchronously","description":"POST /v1/async/orders","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"returnIds":{"type":"boolean","default":false,"description":"Specify whether to return IDs for the [Get job status and…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You need to set this parameter if you want to use the following fields: * subscriptions *…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-preview-order-asynchronously":{"post":{"operationId":"finance_zuora_post_preview_order_asynchronously","summary":"Preview an order asynchronously","description":"POST /v1/async/orders/preview","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-attachments":{"post":{"operationId":"finance_zuora_post_attachments","summary":"Create an attachment","description":"POST /v1/attachments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["associatedObjectType","associatedObjectKey","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"description":{"type":"string","description":"Description of the attachment document."},"associatedObjectType":{"type":"string","enum":["Account","Invoice","Subscription","CreditMemo","DebitMemo"],"description":"The type of the object to add attachements for."},"associatedObjectKey":{"type":"string","description":"For the Subscription type, specify the Subscription Number. An attachment is tied to the Subscription Number and thus viewable with every…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-attachments":{"get":{"operationId":"finance_zuora_get_attachments","summary":"Retrieve an attachment","description":"GET /v1/attachments/{attachment-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"attachment-id","in":"query","required":true,"description":"Id of the attachment you want to view.","schema":{"type":"string","description":"Id of the attachment you want to view."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-attachments":{"post":{"operationId":"finance_zuora_put_attachments","summary":"Update an attachment","description":"PUT /v1/attachments/{attachment-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attachment-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"attachment-id":{"type":"string","description":"Id of the attachment to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-attachments":{"post":{"operationId":"finance_zuora_delete_attachments","summary":"Delete an attachment","description":"DELETE /v1/attachments/{attachment-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attachment-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"attachment-id":{"type":"string","description":"Id of the attachment to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-attachments-list":{"get":{"operationId":"finance_zuora_get_attachments_list","summary":"List attachments by object type and key","description":"GET /v1/attachments/{object-type}/{object-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"object-type","in":"query","required":true,"description":"The type of the object to list attachements for.","schema":{"type":"string","enum":["account","invoice","subscription","creditmemo","debitmemo"],"description":"The type of the object to list attachements for."}},{"name":"object-key","in":"query","required":true,"description":"ID of the object to list attachements for. - If `object-type` is `account`, specify an account ID. - If `object-type` is `invoice`,…","schema":{"type":"string","description":"ID of the object to list attachements for. - If `object-type` is `account`, specify an account ID. - If `object-type` is `invoice`,…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-email-billing-documentsfrom-bill-run":{"post":{"operationId":"finance_zuora_post_email_billing_documentsfrom_bill_run","summary":"Email billing documents generated from a bill run","description":"POST /v1/bill-runs/{billRunId}/emails","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["billRunId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"billRunId":{"type":"string","description":"The ID of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-billing-documents":{"get":{"operationId":"finance_zuora_get_billing_documents","summary":"List billing documents for an account","description":"GET /v1/billing-documents","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"accountId","in":"query","required":true,"description":"The ID of the customer account that the billing documents are associated with.","schema":{"type":"string","description":"The ID of the customer account that the billing documents are associated with."}},{"name":"documentDate","in":"query","required":false,"description":"The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for…","schema":{"type":"string","description":"The date of the billing document. It represents the invoice date for invoices, credit memo date for credit memos, and debit memo date for…"}},{"name":"status","in":"query","required":false,"description":"The status of the billing document.","schema":{"type":"string","enum":["Draft","Posted","Canceled","Error"],"description":"The status of the billing document."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-billing-preview-run":{"post":{"operationId":"finance_zuora_post_billing_preview_run","summary":"Create a billing preview run","description":"POST /v1/billing-preview-runs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-billing-preview-run":{"get":{"operationId":"finance_zuora_get_billing_preview_run","summary":"Retrieve a billing preview run","description":"GET /v1/billing-preview-runs/{billingPreviewRunId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"billingPreviewRunId","in":"query","required":true,"description":"Id of the billing preview run.","schema":{"type":"string","description":"Id of the billing preview run."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-mass-updater":{"post":{"operationId":"finance_zuora_post_mass_updater","summary":"Perform a mass action","description":"POST /v1/bulk","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-mass-updater":{"get":{"operationId":"finance_zuora_get_mass_updater","summary":"List all results of a mass action","description":"GET /v1/bulk/{bulk-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"bulk-key","in":"query","required":true,"description":"String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API.","schema":{"type":"string","description":"String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-mass-updater":{"post":{"operationId":"finance_zuora_put_mass_updater","summary":"Stop a mass action","description":"PUT /v1/bulk/{bulk-key}/stop","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bulk-key"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"bulk-key":{"type":"string","description":"String of 32 characters that identifies a mass action. You get the bulk-key after performing a mass action through the REST API."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-product":{"get":{"operationId":"finance_zuora_get_product","summary":"Retrieve a product","description":"GET /v1/catalog/product/{product-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field.","schema":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field."}},{"name":"product-id","in":"query","required":true,"description":"The unique ID of the product you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe.","schema":{"type":"string","description":"The unique ID of the product you want to retrieve. For example, 8a808255575bdae4015774e9602e16fe."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-catalog":{"get":{"operationId":"finance_zuora_get_catalog","summary":"List all products","description":"GET /v1/catalog/products","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":10,"description":"Number of rows returned per page."}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field.","schema":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the `productRatePlans` field."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-catalog":{"post":{"operationId":"finance_zuora_post_catalog","summary":"Multi-entity: Share a product with an entity","description":"POST /v1/catalog/products/{product-id}/share","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["product-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"product-id":{"type":"string","description":"The unique ID of the product you want to share. For example, 8a808255575bdae4015774e9602e16fe."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-crsby-charge-id":{"get":{"operationId":"finance_zuora_get_crsby_charge_id","summary":"Retrieve a charge revenue summary by charge ID","description":"GET /v1/charge-revenue-summaries/subscription-charges/{charge-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"charge-key","in":"query","required":true,"description":"ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.","schema":{"type":"string","description":"ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-crsby-crsnumber":{"get":{"operationId":"finance_zuora_get_crsby_crsnumber","summary":"List all details of a charge revenue summary","description":"GET /v1/charge-revenue-summaries/{crs-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"crs-number","in":"query","required":true,"description":"The charge revenue summary number.","schema":{"type":"string","description":"The charge revenue summary number."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-connections":{"post":{"operationId":"finance_zuora_post_connections","summary":"Establish a connection to Zuora REST API","description":"POST /v1/connections","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["apiAccessKeyId","apiSecretAccessKey"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"apiAccessKeyId":{"type":"string","description":"Account username"},"apiSecretAccessKey":{"type":"string","description":"Account password"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-scrub-contact":{"post":{"operationId":"finance_zuora_put_scrub_contact","summary":"Scrub a contact","description":"PUT /v1/contacts/{contactId}/scrub","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["contactId"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"contactId":{"type":"string","description":"The ID of the contact that you want to scrub sensitive data from."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memos":{"get":{"operationId":"finance_zuora_get_credit_memos","summary":"List credit memos","description":"GET /v1/creditmemos","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"accountId","in":"query","required":false,"description":"This parameter filters the response based on the `accountId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `accountId` field."}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"appliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `appliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `appliedAmount` field."}},{"name":"autoApplyUponPosting","in":"query","required":false,"description":"This parameter filters the response based on the `autoApplyUponPosting` field.","schema":{"type":"boolean","description":"This parameter filters the response based on the `autoApplyUponPosting` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"creditMemoDate","in":"query","required":false,"description":"This parameter filters the response based on the `creditMemoDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `creditMemoDate` field."}},{"name":"currency","in":"query","required":false,"description":"This parameter filters the response based on the `currency` field.","schema":{"type":"string","description":"This parameter filters the response based on the `currency` field."}},{"name":"excludeFromAutoApplyRules","in":"query","required":false,"description":"This parameter filters the response based on the `excludeFromAutoApplyRules` field.","schema":{"type":"boolean","description":"This parameter filters the response based on the `excludeFromAutoApplyRules` field."}},{"name":"number","in":"query","required":false,"description":"This parameter filters the response based on the `number` field.","schema":{"type":"string","description":"This parameter filters the response based on the `number` field."}},{"name":"referredInvoiceId","in":"query","required":false,"description":"This parameter filters the response based on the `referredInvoiceId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `referredInvoiceId` field."}},{"name":"refundAmount","in":"query","required":false,"description":"This parameter filters the response based on the `refundAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `refundAmount` field."}},{"name":"status","in":"query","required":false,"description":"This parameter filters the response based on the `status` field.","schema":{"type":"string","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"description":"This parameter filters the response based on the `status` field."}},{"name":"targetDate","in":"query","required":false,"description":"This parameter filters the response based on the `targetDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `targetDate` field."}},{"name":"taxAmount","in":"query","required":false,"description":"This parameter filters the response based on the `taxAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `taxAmount` field."}},{"name":"totalTaxExemptAmount","in":"query","required":false,"description":"This parameter filters the response based on the `totalTaxExemptAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `totalTaxExemptAmount` field."}},{"name":"transferredToAccounting","in":"query","required":false,"description":"This parameter filters the response based on the `transferredToAccounting` field.","schema":{"type":"string","enum":["Processing","Yes","No","Error","Ignore"],"description":"This parameter filters the response based on the `transferredToAccounting` field."}},{"name":"unappliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `unappliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `unappliedAmount` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-credit-memo-from-prpc":{"post":{"operationId":"finance_zuora_post_credit_memo_from_prpc","summary":"Create a credit memo from a charge","description":"POST /v1/creditmemos","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo":{"get":{"operationId":"finance_zuora_get_credit_memo","summary":"Retrieve a credit memo","description":"GET /v1/creditmemos/{creditMemoId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-credit-memo":{"post":{"operationId":"finance_zuora_put_update_credit_memo","summary":"Update a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-credit-memo":{"post":{"operationId":"finance_zuora_delete_credit_memo","summary":"Delete a credit memo","description":"DELETE /v1/creditmemos/{creditMemoId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-apply-credit-memo":{"post":{"operationId":"finance_zuora_put_apply_credit_memo","summary":"Apply a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}/apply","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-cancel-credit-memo":{"post":{"operationId":"finance_zuora_put_cancel_credit_memo","summary":"Cancel a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-email-credit-memo":{"post":{"operationId":"finance_zuora_post_email_credit_memo","summary":"Email a credit memo","description":"POST /v1/creditmemos/{creditMemoId}/emails","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The ID of a posted credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-upload-file-for-credit-memo":{"post":{"operationId":"finance_zuora_post_upload_file_for_credit_memo","summary":"Upload a file for a credit memo","description":"POST /v1/creditmemos/{creditMemoId}/files","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"creditMemoId":{"type":"string","description":"The ID of the credit memo that you want to upload a PDF file for. For example, 402890555a7e9791015a879f064a0054."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-items":{"get":{"operationId":"finance_zuora_get_credit_memo_items","summary":"List credit memo items","description":"GET /v1/creditmemos/{creditMemoId}/items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. See [Minor…","schema":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"appliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `appliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `appliedAmount` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"id","in":"query","required":false,"description":"This parameter filters the response based on the `id` field.","schema":{"type":"string","description":"This parameter filters the response based on the `id` field."}},{"name":"refundAmount","in":"query","required":false,"description":"This parameter filters the response based on the `refundAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `refundAmount` field."}},{"name":"serviceEndDate","in":"query","required":false,"description":"This parameter filters the response based on the `serviceEndDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `serviceEndDate` field."}},{"name":"serviceStartDate","in":"query","required":false,"description":"This parameter filters the response based on the `serviceStartDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `serviceStartDate` field."}},{"name":"sku","in":"query","required":false,"description":"This parameter filters the response based on the `sku` field.","schema":{"type":"string","description":"This parameter filters the response based on the `sku` field."}},{"name":"skuName","in":"query","required":false,"description":"This parameter filters the response based on the `skuName` field.","schema":{"type":"string","description":"This parameter filters the response based on the `skuName` field."}},{"name":"sourceItemId","in":"query","required":false,"description":"This parameter filters the response based on the `sourceItemId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `sourceItemId` field."}},{"name":"subscriptionId","in":"query","required":false,"description":"This parameter filters the response based on the `subscriptionId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `subscriptionId` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-item":{"get":{"operationId":"finance_zuora_get_credit_memo_item","summary":"Retrieve a credit memo item","description":"GET /v1/creditmemos/{creditMemoId}/items/{cmitemid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"cmitemid","in":"query","required":true,"description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo…","schema":{"type":"string","description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. See [Minor…","schema":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-taxation-items-of-credit-memo-item":{"get":{"operationId":"finance_zuora_get_taxation_items_of_credit_memo_item","summary":"List all taxation items of a credit memo item","description":"GET /v1/creditmemos/{creditMemoId}/items/{cmitemid}/taxation-items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"cmitemid","in":"query","required":true,"description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo…","schema":{"type":"string","description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [List credit memo…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-parts":{"get":{"operationId":"finance_zuora_get_credit_memo_parts","summary":"List all parts of a credit memo","description":"GET /v1/creditmemos/{creditMemoId}/parts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-part":{"get":{"operationId":"finance_zuora_get_credit_memo_part","summary":"Retrieve a credit memo part","description":"GET /v1/creditmemos/{creditMemoId}/parts/{partid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…","schema":{"type":"string","description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-item-parts":{"get":{"operationId":"finance_zuora_get_credit_memo_item_parts","summary":"List all credit memo part items","description":"GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…","schema":{"type":"string","description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-credit-memo-item-part":{"get":{"operationId":"finance_zuora_get_credit_memo_item_part","summary":"Retrieve a credit memo part item","description":"GET /v1/creditmemos/{creditMemoId}/parts/{partid}/itemparts/{itempartid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…","schema":{"type":"string","description":"The unique ID of a specific credit memo part. You can get the credit memo part ID from the response of [List all parts of a credit…"}},{"name":"itempartid","in":"query","required":true,"description":"The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [List all credit memo…","schema":{"type":"string","description":"The unique ID of a specific credit memo part item. You can get the credit memo part item ID from the response of [List all credit memo…"}},{"name":"creditMemoId","in":"query","required":true,"description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.","schema":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-credit-memo-pdf":{"post":{"operationId":"finance_zuora_post_credit_memo_pdf","summary":"Generate a credit memo PDF file","description":"POST /v1/creditmemos/{creditMemoId}/pdfs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of the credit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-post-credit-memo":{"post":{"operationId":"finance_zuora_put_post_credit_memo","summary":"Post a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}/post","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-cm-taxation-items":{"post":{"operationId":"finance_zuora_post_cm_taxation_items","summary":"Create taxation items for a credit memo","description":"POST /v1/creditmemos/{creditMemoId}/taxationitems","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-unapply-credit-memo":{"post":{"operationId":"finance_zuora_put_unapply_credit_memo","summary":"Unapply a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}/unapply","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-unpost-credit-memo":{"post":{"operationId":"finance_zuora_put_unpost_credit_memo","summary":"Unpost a credit memo","description":"PUT /v1/creditmemos/{creditMemoId}/unpost","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditMemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-refund-credit-memo":{"post":{"operationId":"finance_zuora_post_refund_credit_memo","summary":"Refund a credit memo","description":"POST /v1/creditmemos/{creditmemoId}/refunds","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["creditmemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"creditmemoId":{"type":"string","description":"The unique ID of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-custom-exchange-rates":{"get":{"operationId":"finance_zuora_get_custom_exchange_rates","summary":"List custom exchange rates by currency","description":"GET /v1/custom-exchange-rates/{currency}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"currency","in":"query","required":true,"description":"The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency. The value…","schema":{"type":"string","description":"The target base currency of the tenant. The exchange rates in the response are calculated in relation to the target currency. The value…"}},{"name":"startDate","in":"query","required":true,"description":"Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-15. The…","schema":{"type":"string","description":"Start date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-15. The…"}},{"name":"endDate","in":"query","required":true,"description":"End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-16. The…","schema":{"type":"string","description":"End date of the date range for which you want to get exchange rates. The date must be in yyyy-mm-dd format, for example, 2016-01-16. The…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-debit-memos":{"get":{"operationId":"finance_zuora_get_debit_memos","summary":"List debit memos","description":"GET /v1/debitmemos","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"accountId","in":"query","required":false,"description":"This parameter filters the response based on the `accountId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `accountId` field."}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"balance","in":"query","required":false,"description":"This parameter filters the response based on the `balance` field.","schema":{"type":"number","description":"This parameter filters the response based on the `balance` field."}},{"name":"beAppliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `beAppliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `beAppliedAmount` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"currency","in":"query","required":false,"description":"This parameter filters the response based on the `currency` field.","schema":{"type":"string","description":"This parameter filters the response based on the `currency` field."}},{"name":"debitMemoDate","in":"query","required":false,"description":"This parameter filters the response based on the `debitMemoDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `debitMemoDate` field."}},{"name":"dueDate","in":"query","required":false,"description":"This parameter filters the response based on the `dueDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `dueDate` field."}},{"name":"number","in":"query","required":false,"description":"This parameter filters the response based on the `number` field.","schema":{"type":"string","description":"This parameter filters the response based on the `number` field."}},{"name":"referredInvoiceId","in":"query","required":false,"description":"This parameter filters the response based on the `referredInvoiceId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `referredInvoiceId` field."}},{"name":"status","in":"query","required":false,"description":"This parameter filters the response based on the `status` field.","schema":{"type":"string","enum":["Draft","Posted","Canceled","Error","PendingForTax","Generating","CancelInProgress"],"description":"This parameter filters the response based on the `status` field."}},{"name":"targetDate","in":"query","required":false,"description":"This parameter filters the response based on the `targetDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `targetDate` field."}},{"name":"taxAmount","in":"query","required":false,"description":"This parameter filters the response based on the `taxAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `taxAmount` field."}},{"name":"totalTaxExemptAmount","in":"query","required":false,"description":"This parameter filters the response based on the `totalTaxExemptAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `totalTaxExemptAmount` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-debit-memo-from-prpc":{"post":{"operationId":"finance_zuora_post_debit_memo_from_prpc","summary":"Create a debit memo from a charge","description":"POST /v1/debitmemos","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-batch-update-debit-memos":{"post":{"operationId":"finance_zuora_put_batch_update_debit_memos","summary":"Update debit memos","description":"PUT /v1/debitmemos","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-debit-memo":{"get":{"operationId":"finance_zuora_get_debit_memo","summary":"Retrieve a debit memo","description":"GET /v1/debitmemos/{debitMemoId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"debitMemoId","in":"query","required":true,"description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.","schema":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-debit-memo":{"post":{"operationId":"finance_zuora_put_debit_memo","summary":"Update a debit memo","description":"PUT /v1/debitmemos/{debitMemoId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-debit-memo":{"post":{"operationId":"finance_zuora_delete_debit_memo","summary":"Delete a debit memo","description":"DELETE /v1/debitmemos/{debitMemoId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-debit-memo-application-parts":{"get":{"operationId":"finance_zuora_get_debit_memo_application_parts","summary":"List all application parts of a debit memo","description":"GET /v1/debitmemos/{debitMemoId}/application-parts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"debitMemoId","in":"query","required":true,"description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.","schema":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-cancel-debit-memo":{"post":{"operationId":"finance_zuora_put_cancel_debit_memo","summary":"Cancel a debit memo","description":"PUT /v1/debitmemos/{debitMemoId}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-debit-memo-collect":{"post":{"operationId":"finance_zuora_post_debit_memo_collect","summary":"Collect a posted debit memo","description":"POST /v1/debitmemos/{debitMemoId}/collect","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-email-debit-memo":{"post":{"operationId":"finance_zuora_post_email_debit_memo","summary":"Email a debit memo","description":"POST /v1/debitmemos/{debitMemoId}/emails","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The ID of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-upload-file-for-debit-memo":{"post":{"operationId":"finance_zuora_post_upload_file_for_debit_memo","summary":"Upload a file for a debit memo","description":"POST /v1/debitmemos/{debitMemoId}/files","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"debitMemoId":{"type":"string","description":"The ID of the debit memo that you want to upload a PDF file for. For example, 402890555a87d7f5015a8919e4fe002e."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-debit-memo-items":{"get":{"operationId":"finance_zuora_get_debit_memo_items","summary":"List debit memo items","description":"GET /v1/debitmemos/{debitMemoId}/items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"debitMemoId","in":"query","required":true,"description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.","schema":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. See [Minor…","schema":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"beAppliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `beAppliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `beAppliedAmount` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"id","in":"query","required":false,"description":"This parameter filters the response based on the `id` field.","schema":{"type":"string","description":"This parameter filters the response based on the `id` field."}},{"name":"serviceEndDate","in":"query","required":false,"description":"This parameter filters the response based on the `serviceEndDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `serviceEndDate` field."}},{"name":"serviceStartDate","in":"query","required":false,"description":"This parameter filters the response based on the `serviceStartDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `serviceStartDate` field."}},{"name":"sku","in":"query","required":false,"description":"This parameter filters the response based on the `sku` field.","schema":{"type":"string","description":"This parameter filters the response based on the `sku` field."}},{"name":"skuName","in":"query","required":false,"description":"This parameter filters the response based on the `skuName` field.","schema":{"type":"string","description":"This parameter filters the response based on the `skuName` field."}},{"name":"sourceItemId","in":"query","required":false,"description":"This parameter filters the response based on the `sourceItemId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `sourceItemId` field."}},{"name":"subscriptionId","in":"query","required":false,"description":"This parameter filters the response based on the `subscriptionId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `subscriptionId` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-debit-memo-item":{"get":{"operationId":"finance_zuora_get_debit_memo_item","summary":"Retrieve a debit memo item","description":"GET /v1/debitmemos/{debitMemoId}/items/{dmitemid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"dmitemid","in":"query","required":true,"description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo…","schema":{"type":"string","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo…"}},{"name":"debitMemoId","in":"query","required":true,"description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.","schema":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}},{"name":"zuora-version","in":"query","required":false,"description":"The minor version of the Zuora REST API. See [Minor…","schema":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-taxation-items-of-debit-memo-item":{"get":{"operationId":"finance_zuora_get_taxation_items_of_debit_memo_item","summary":"List all taxation items of a debit memo item","description":"GET /v1/debitmemos/{debitMemoId}/items/{dmitemid}/taxation-items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"dmitemid","in":"query","required":true,"description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo…","schema":{"type":"string","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [List debit memo…"}},{"name":"debitMemoId","in":"query","required":true,"description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e.","schema":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-debit-memo-pdf":{"post":{"operationId":"finance_zuora_post_debit_memo_pdf","summary":"Generate a debit memo PDF file","description":"POST /v1/debitmemos/{debitMemoId}/pdfs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of the debit memo that you want to create a PDF file for. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-post-debit-memo":{"post":{"operationId":"finance_zuora_put_post_debit_memo","summary":"Post a debit memo","description":"PUT /v1/debitmemos/{debitMemoId}/post","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-dm-taxation-items":{"post":{"operationId":"finance_zuora_post_dm_taxation_items","summary":"Create taxation items for a debit memo","description":"POST /v1/debitmemos/{debitMemoId}/taxationitems","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-unpost-debit-memo":{"post":{"operationId":"finance_zuora_put_unpost_debit_memo","summary":"Unpost a debit memo","description":"PUT /v1/debitmemos/{debitMemoId}/unpost","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["debitMemoId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"debitMemoId":{"type":"string","description":"The unique ID of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-describe":{"get":{"operationId":"finance_zuora_get_describe","summary":"Describe an object","description":"GET /v1/describe/{object}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"object","in":"query","required":true,"description":"API name of an object in your Zuora tenant. For example, `InvoiceItem`. See [Zuora Object…","schema":{"type":"string","description":"API name of an object in your Zuora tenant. For example, `InvoiceItem`. See [Zuora Object…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-document-properties":{"post":{"operationId":"finance_zuora_post_document_properties","summary":"Create document properties","description":"POST /v1/document-properties","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-document-properties":{"post":{"operationId":"finance_zuora_put_document_properties","summary":"Update document properties","description":"PUT /v1/document-properties/{documentPropertiesId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documentPropertiesId","body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"documentPropertiesId":{"type":"string","description":"The unique ID of document properties to be updated. For example, 402892c74c9193cd014c96bbe7c101f9."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-document-properties":{"post":{"operationId":"finance_zuora_delete_document_properties","summary":"Delete document properties","description":"DELETE /v1/document-properties/{documentPropertiesId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["documentPropertiesId"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"documentPropertiesId":{"type":"string","description":"The unique ID of document properties. For example, 402892c74c9193cd014c96bbe7c101f9."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-document-properies":{"get":{"operationId":"finance_zuora_get_document_properies","summary":"List all properties of a billing document","description":"GET /v1/document-properties/{documentType}/{documentId}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"documentType","in":"query","required":true,"description":"The type of the billing document.","schema":{"type":"string","enum":["Invoice","CreditMemo","DebitMemo"],"description":"The type of the billing document."}},{"name":"documentId","in":"query","required":true,"description":"The unique ID of document properties to be retrieved. For example, 402892c74c9193cd014c96bbe7c101f9.","schema":{"type":"string","description":"The unique ID of document properties to be retrieved. For example, 402892c74c9193cd014c96bbe7c101f9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-entities":{"get":{"operationId":"finance_zuora_get_entities","summary":"Multi-entity: List entities","description":"GET /v1/entities","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"provisioned","in":"query","required":false,"description":"Specify whether to retrieve provisioned or unprovisioned entities: - `true`: Provisioned entities - `false`: Unprovisioned entities If you…","schema":{"type":"string","description":"Specify whether to retrieve provisioned or unprovisioned entities: - `true`: Provisioned entities - `false`: Unprovisioned entities If you…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-entities":{"post":{"operationId":"finance_zuora_post_entities","summary":"Multi-entity: Create an entity","description":"POST /v1/entities","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-entity-by-id":{"get":{"operationId":"finance_zuora_get_entity_by_id","summary":"Multi-entity: Retrieve an entity","description":"GET /v1/entities/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"id","in":"query","required":true,"description":"Specify the Id of the entity that you want to retrieve. You can get the entity Id from the GET Entities call.","schema":{"type":"string","description":"Specify the Id of the entity that you want to retrieve. You can get the entity Id from the GET Entities call."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-entities":{"post":{"operationId":"finance_zuora_put_entities","summary":"Multi-entity: Update an entity","description":"PUT /v1/entities/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"The Id of the entity that you want to edit. You can get the entity Id from the GET Entities call."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-entities":{"post":{"operationId":"finance_zuora_delete_entities","summary":"Multi-entity: Delete an entity","description":"DELETE /v1/entities/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"Specify the Id of the entity that you want to delete. You can get the entity Id from the GET Entities call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-provision-entity":{"post":{"operationId":"finance_zuora_put_provision_entity","summary":"Multi-entity: Provision an entity","description":"PUT /v1/entities/{id}/provision","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"id":{"type":"string","description":"Specify the Id of the entity that you want to provision. You can get the entity Id from the GET Entities call."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-entity-connections":{"get":{"operationId":"finance_zuora_get_entity_connections","summary":"Multi-entity: List connections","description":"GET /v1/entity-connections","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":30,"description":"Number of rows returned per page."}},{"name":"type","in":"query","required":false,"description":"Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - `inbound`: All the incoming connections to…","schema":{"type":"string","enum":["inbound","outbound"],"description":"Specifies whether to retrieve inbound or outbound connections for an entity. Possible values: - `inbound`: All the incoming connections to…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-entity-connections":{"post":{"operationId":"finance_zuora_post_entity_connections","summary":"Multi-entity: Initiate a connection request","description":"POST /v1/entity-connections","tags":["finance"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-entity-connections-accept":{"post":{"operationId":"finance_zuora_put_entity_connections_accept","summary":"Multi-entity: Accept a connection request","description":"PUT /v1/entity-connections/{connection-id}/accept","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"connection-id":{"type":"string","description":"The ID of the connection that you want to accept."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-entity-connections-deny":{"post":{"operationId":"finance_zuora_put_entity_connections_deny","summary":"Multi-entity: Deny a connection request","description":"PUT /v1/entity-connections/{connection-id}/deny","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"connection-id":{"type":"string","description":"The ID of the connection that you want to deny."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-entity-connections-disconnect":{"post":{"operationId":"finance_zuora_put_entity_connections_disconnect","summary":"Multi-entity: Disconnect a connection","description":"PUT /v1/entity-connections/{connection-id}/disconnect","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["connection-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"connection-id":{"type":"string","description":"The ID of the connection that you want to disconnect."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-files":{"get":{"operationId":"finance_zuora_get_files","summary":"Retrieve a file","description":"GET /v1/files/{file-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"file-id","in":"query","required":true,"description":"The Zuora ID of the file to retrieve.","schema":{"type":"string","description":"The Zuora ID of the file to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-reverse-payment":{"post":{"operationId":"finance_zuora_post_reverse_payment","summary":"Reverse a payment","description":"POST /v1/gateway-settlement/payments/{payment-id}/chargeback","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-id":{"type":"string","description":"Unique ID of the payment."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-reject-payment":{"post":{"operationId":"finance_zuora_post_reject_payment","summary":"Reject a payment","description":"POST /v1/gateway-settlement/payments/{payment-id}/reject","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-id":{"type":"string","description":"Unique ID of the payment."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-settle-payment":{"post":{"operationId":"finance_zuora_post_settle_payment","summary":"Settle a payment","description":"POST /v1/gateway-settlement/payments/{payment-id}/settle","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-id":{"type":"string","description":"Unique ID of the payment."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-hmacsignatures":{"post":{"operationId":"finance_zuora_post_hmacsignatures","summary":"Generate an HMAC signature","description":"POST /v1/hmac-signatures","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-hosted-pages":{"get":{"operationId":"finance_zuora_get_hosted_pages","summary":"List hosted pages","description":"GET /v1/hostedpages","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"versionNumber","in":"query","required":false,"description":"Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for…","schema":{"type":"string","description":"Version of the Payment Pages for which you want to retrieve the configuration information. Specify 1 for Payment Pages 1.0 or 2 for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-standalone-invoice":{"post":{"operationId":"finance_zuora_post_standalone_invoice","summary":"Create a standalone invoice","description":"POST /v1/invoices","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-batch-update-invoices":{"post":{"operationId":"finance_zuora_put_batch_update_invoices","summary":"Update invoices","description":"PUT /v1/invoices","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-invoice":{"post":{"operationId":"finance_zuora_put_update_invoice","summary":"Update an invoice","description":"PUT /v1/invoices/{invoiceId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoiceId":{"type":"string","description":"The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-invoice-application-parts":{"get":{"operationId":"finance_zuora_get_invoice_application_parts","summary":"List all application parts of an invoice","description":"GET /v1/invoices/{invoiceId}/application-parts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"invoiceId","in":"query","required":true,"description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.","schema":{"type":"string","description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-credit-memo-from-invoice":{"post":{"operationId":"finance_zuora_post_credit_memo_from_invoice","summary":"Create a credit memo from an invoice","description":"POST /v1/invoices/{invoiceId}/creditmemos","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"},"invoiceId":{"type":"string","description":"The ID of an invoice that you want to create a credit memo from."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-debit-memo-from-invoice":{"post":{"operationId":"finance_zuora_post_debit_memo_from_invoice","summary":"Create a debit memo from an invoice","description":"POST /v1/invoices/{invoiceId}/debitmemos","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoiceId":{"type":"string","description":"The ID of an invoice that you want to create a debit memo from."},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. See [Minor…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-email-invoice":{"post":{"operationId":"finance_zuora_post_email_invoice","summary":"Email an invoice","description":"POST /v1/invoices/{invoiceId}/emails","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoiceId":{"type":"string","description":"The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-invoice-files":{"get":{"operationId":"finance_zuora_get_invoice_files","summary":"List all files of an invoice","description":"GET /v1/invoices/{invoiceId}/files","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"invoiceId","in":"query","required":true,"description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.","schema":{"type":"string","description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-upload-file-for-invoice":{"post":{"operationId":"finance_zuora_post_upload_file_for_invoice","summary":"Upload a file for an invoice","description":"POST /v1/invoices/{invoiceId}/files","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"invoiceId":{"type":"string","description":"The ID of the invoice that you want to upload a PDF file for. For example, 2c92c8955bd63cc1015bd7c151af02ab."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-invoice-items":{"get":{"operationId":"finance_zuora_get_invoice_items","summary":"List all items of an invoice","description":"GET /v1/invoices/{invoiceId}/items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"invoiceId","in":"query","required":true,"description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.","schema":{"type":"string","description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-taxation-items-of-invoice-item":{"get":{"operationId":"finance_zuora_get_taxation_items_of_invoice_item","summary":"List all taxation items of an invoice item","description":"GET /v1/invoices/{invoiceId}/items/{itemId}/taxation-items","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"invoiceId","in":"query","required":true,"description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab.","schema":{"type":"string","description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."}},{"name":"itemId","in":"query","required":true,"description":"The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef.","schema":{"type":"string","description":"The unique ID of an invoice item. For example, 2c86c8955bd63cc1015bd7c151af02ef."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-reverse-invoice":{"post":{"operationId":"finance_zuora_put_reverse_invoice","summary":"Reverse an invoice","description":"PUT /v1/invoices/{invoiceId}/reverse","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoiceId":{"type":"string","description":"The ID of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-write-off-invoice":{"post":{"operationId":"finance_zuora_put_write_off_invoice","summary":"Write off an invoice","description":"PUT /v1/invoices/{invoiceId}/write-off","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoiceId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoiceId":{"type":"string","description":"The unique ID of an invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-summary-journal-entry":{"post":{"operationId":"finance_zuora_post_summary_journal_entry","summary":"Create a summary journal entry","description":"POST /v1/journal-entries","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-summary-journal-entries":{"get":{"operationId":"finance_zuora_get_all_summary_journal_entries","summary":"List all summary journal entries in a journal run","description":"GET /v1/journal-entries/journal-runs/{jr-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":8,"description":"Number of rows returned per page."}},{"name":"jr-number","in":"query","required":true,"description":"Journal run number.","schema":{"type":"string","description":"Journal run number."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-summary-journal-entry":{"get":{"operationId":"finance_zuora_get_summary_journal_entry","summary":"Retrieve a summary journal entry","description":"GET /v1/journal-entries/{je-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"je-number","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-summary-journal-entry":{"post":{"operationId":"finance_zuora_delete_summary_journal_entry","summary":"Delete a summary journal entry","description":"DELETE /v1/journal-entries/{je-number}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["je-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"je-number":{"type":"string","description":"Journal entry number in the format JE-00000001."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-basic-summary-journal-entry":{"post":{"operationId":"finance_zuora_put_basic_summary_journal_entry","summary":"Update a summary journal entry","description":"PUT /v1/journal-entries/{je-number}/basic-information","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["je-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"je-number":{"type":"string","description":"Journal entry number in the format JE-00000001."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-summary-journal-entry":{"post":{"operationId":"finance_zuora_put_summary_journal_entry","summary":"Cancel a summary journal entry","description":"PUT /v1/journal-entries/{je-number}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["je-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"je-number":{"type":"string","description":"Journal entry number in the format JE-00000001."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-journal-run":{"post":{"operationId":"finance_zuora_post_journal_run","summary":"Create a journal run","description":"POST /v1/journal-runs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-journal-run":{"get":{"operationId":"finance_zuora_get_journal_run","summary":"Retrieve a journal run","description":"GET /v1/journal-runs/{jr-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"jr-number","in":"query","required":true,"description":"Journal run number. Must be a valid journal run number in the format `JR-00000001`.","schema":{"type":"string","description":"Journal run number. Must be a valid journal run number in the format `JR-00000001`."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-journal-run":{"post":{"operationId":"finance_zuora_delete_journal_run","summary":"Delete a journal run","description":"DELETE /v1/journal-runs/{jr-number}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jr-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"jr-number":{"type":"string","description":"Journal run number. Must be a valid journal run number in the format `JR-00000001`."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-journal-run":{"post":{"operationId":"finance_zuora_put_journal_run","summary":"Cancel a journal run","description":"PUT /v1/journal-runs/{jr-number}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jr-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"jr-number":{"type":"string","description":"Journal run number. Must be a valid journal run number in the format JR-00000001. You can only cancel a journal run whose status is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-callout-history":{"get":{"operationId":"finance_zuora_get_callout_history","summary":"List callout notification histories","description":"GET /v1/notification-history/callout","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"endTime","in":"query","required":false,"description":"The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss.","schema":{"type":"string","description":"The final date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss."}},{"name":"startTime","in":"query","required":false,"description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss.","schema":{"type":"string","description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss."}},{"name":"objectId","in":"query","required":false,"description":"The ID of an object that triggered a callout notification. **Note**: If the `objectId` is present in query parameters, the `eventCategory`…","schema":{"type":"string","description":"The ID of an object that triggered a callout notification. **Note**: If the `objectId` is present in query parameters, the `eventCategory`…"}},{"name":"failedOnly","in":"query","required":false,"description":"If `true`, only return failed records. If `false`, return all records in the given date range. The default value is `true`. **Note**: The…","schema":{"type":"boolean","description":"If `true`, only return failed records. If `false`, return all records in the given date range. The default value is `true`. **Note**: The…"}},{"name":"eventCategory","in":"query","required":false,"description":"Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if…","schema":{"type":"string","description":"Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if…"}},{"name":"includeResponseContent","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-email-history":{"get":{"operationId":"finance_zuora_get_email_history","summary":"List email notification histories","description":"GET /v1/notification-history/email","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"endTime","in":"query","required":false,"description":"The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime -…","schema":{"type":"string","description":"The end date and time of records to be returned. Defaults to now. Use format yyyy-MM-ddTHH:mm:ss. The maximum date range (endTime -…"}},{"name":"startTime","in":"query","required":false,"description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date…","schema":{"type":"string","description":"The initial date and time of records to be returned. Defaults to (end time - 1 day). Use format yyyy-MM-ddTHH:mm:ss. The maximum date…"}},{"name":"objectId","in":"query","required":false,"description":"The Id of an object that triggered an email notification. **Note**: If the `objectId` is present in query parameters, the `eventCategory`…","schema":{"type":"string","description":"The Id of an object that triggered an email notification. **Note**: If the `objectId` is present in query parameters, the `eventCategory`…"}},{"name":"failedOnly","in":"query","required":false,"description":"If `true`, only returns failed records. When `false`, returns all records in the given date range. Defaults to `true` when not specified.…","schema":{"type":"boolean","description":"If `true`, only returns failed records. When `false`, returns all records in the given date range. Defaults to `true` when not specified.…"}},{"name":"eventCategory","in":"query","required":false,"description":"Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if…","schema":{"type":"string","description":"Category of records to be returned by event category. The following formats are supported: * `{Event Type Namespace}:{Event Type Name}` if…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postaccount":{"post":{"operationId":"finance_zuora_object_postaccount","summary":"CRUD: Create an account","description":"POST /v1/object/account","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getaccount":{"get":{"operationId":"finance_zuora_object_getaccount","summary":"CRUD: Retrieve an account","description":"GET /v1/object/account/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putaccount":{"post":{"operationId":"finance_zuora_object_putaccount","summary":"CRUD: Update an account","description":"PUT /v1/object/account/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteaccount":{"post":{"operationId":"finance_zuora_object_deleteaccount","summary":"CRUD: Delete an account","description":"DELETE /v1/object/account/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getamendment":{"get":{"operationId":"finance_zuora_object_getamendment","summary":"CRUD: Retrieve an amendment","description":"GET /v1/object/amendment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putamendment":{"post":{"operationId":"finance_zuora_object_putamendment","summary":"CRUD: Update an amendment","description":"PUT /v1/object/amendment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteamendment":{"post":{"operationId":"finance_zuora_object_deleteamendment","summary":"CRUD: Delete an amendment","description":"DELETE /v1/object/amendment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postbill-run":{"post":{"operationId":"finance_zuora_object_postbill_run","summary":"CRUD: Create a bill run","description":"POST /v1/object/bill-run","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getbill-run":{"get":{"operationId":"finance_zuora_object_getbill_run","summary":"CRUD: Retrieve a bill run","description":"GET /v1/object/bill-run/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putbill-run":{"post":{"operationId":"finance_zuora_object_putbill_run","summary":"CRUD: Post or cancel a bill run","description":"PUT /v1/object/bill-run/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletebill-run":{"post":{"operationId":"finance_zuora_object_deletebill_run","summary":"CRUD: Delete a bill run","description":"DELETE /v1/object/bill-run/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getcommunication-profile":{"get":{"operationId":"finance_zuora_object_getcommunication_profile","summary":"CRUD: Retrieve a communication profile","description":"GET /v1/object/communication-profile/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postcontact":{"post":{"operationId":"finance_zuora_object_postcontact","summary":"CRUD: Create a contact","description":"POST /v1/object/contact","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getcontact":{"get":{"operationId":"finance_zuora_object_getcontact","summary":"CRUD: Retrieve a contact","description":"GET /v1/object/contact/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putcontact":{"post":{"operationId":"finance_zuora_object_putcontact","summary":"CRUD: Update a contact","description":"PUT /v1/object/contact/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletecontact":{"post":{"operationId":"finance_zuora_object_deletecontact","summary":"CRUD: Delete a contact","description":"DELETE /v1/object/contact/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postcredit-balance-adjustment":{"post":{"operationId":"finance_zuora_object_postcredit_balance_adjustment","summary":"CRUD: Create a credit balance adjustment","description":"POST /v1/object/credit-balance-adjustment","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getcredit-balance-adjustment":{"get":{"operationId":"finance_zuora_object_getcredit_balance_adjustment","summary":"CRUD: Retrieve a credit balance adjustment","description":"GET /v1/object/credit-balance-adjustment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putcredit-balance-adjustment":{"post":{"operationId":"finance_zuora_object_putcredit_balance_adjustment","summary":"CRUD: Update a credit balance adjustment","description":"PUT /v1/object/credit-balance-adjustment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postexport":{"post":{"operationId":"finance_zuora_object_postexport","summary":"CRUD: Create an export","description":"POST /v1/object/export","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getexport":{"get":{"operationId":"finance_zuora_object_getexport","summary":"CRUD: Retrieve an export","description":"GET /v1/object/export/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postfeature":{"post":{"operationId":"finance_zuora_object_postfeature","summary":"CRUD: Create a feature","description":"POST /v1/object/feature","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getfeature":{"get":{"operationId":"finance_zuora_object_getfeature","summary":"CRUD: Retrieve a feature","description":"GET /v1/object/feature/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putfeature":{"post":{"operationId":"finance_zuora_object_putfeature","summary":"CRUD: Update a feature","description":"PUT /v1/object/feature/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletefeature":{"post":{"operationId":"finance_zuora_object_deletefeature","summary":"CRUD: Delete a feature","description":"DELETE /v1/object/feature/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postimport":{"post":{"operationId":"finance_zuora_object_postimport","summary":"CRUD: Create an import","description":"POST /v1/object/import","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getimport":{"get":{"operationId":"finance_zuora_object_getimport","summary":"CRUD: Retrieve an import","description":"GET /v1/object/import/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postinvoice-adjustment":{"post":{"operationId":"finance_zuora_object_postinvoice_adjustment","summary":"CRUD: Create an invoice adjustment","description":"POST /v1/object/invoice-adjustment","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-adjustment":{"get":{"operationId":"finance_zuora_object_getinvoice_adjustment","summary":"CRUD: Retrieve an invoice adjustment","description":"GET /v1/object/invoice-adjustment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putinvoice-adjustment":{"post":{"operationId":"finance_zuora_object_putinvoice_adjustment","summary":"CRUD: Update an invoice adjustment","description":"PUT /v1/object/invoice-adjustment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteinvoice-adjustment":{"post":{"operationId":"finance_zuora_object_deleteinvoice_adjustment","summary":"CRUD: Delete an invoice adjustment","description":"DELETE /v1/object/invoice-adjustment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-item-adjustment":{"get":{"operationId":"finance_zuora_object_getinvoice_item_adjustment","summary":"CRUD: Retrieve an invoice item adjustment","description":"GET /v1/object/invoice-item-adjustment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteinvoice-item-adjustment":{"post":{"operationId":"finance_zuora_object_deleteinvoice_item_adjustment","summary":"CRUD: Delete an invoice item adjustment","description":"DELETE /v1/object/invoice-item-adjustment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-item":{"get":{"operationId":"finance_zuora_object_getinvoice_item","summary":"CRUD: Retrieve an invoice item","description":"GET /v1/object/invoice-item/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postinvoice-payment":{"post":{"operationId":"finance_zuora_object_postinvoice_payment","summary":"CRUD: Create an invoice payment","description":"POST /v1/object/invoice-payment","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-payment":{"get":{"operationId":"finance_zuora_object_getinvoice_payment","summary":"CRUD: Retrieve an invoice payment","description":"GET /v1/object/invoice-payment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putinvoice-payment":{"post":{"operationId":"finance_zuora_object_putinvoice_payment","summary":"CRUD: Update an invoice payment","description":"PUT /v1/object/invoice-payment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-split-item":{"get":{"operationId":"finance_zuora_object_getinvoice_split_item","summary":"CRUD: Retrieve an invoice split item","description":"GET /v1/object/invoice-split-item/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice-split":{"get":{"operationId":"finance_zuora_object_getinvoice_split","summary":"CRUD: Retrieve an invoice split","description":"GET /v1/object/invoice-split/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getinvoice":{"get":{"operationId":"finance_zuora_object_getinvoice","summary":"CRUD: Retrieve an invoice","description":"GET /v1/object/invoice/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putinvoice":{"post":{"operationId":"finance_zuora_object_putinvoice","summary":"CRUD: Update an invoice","description":"PUT /v1/object/invoice/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteinvoice":{"post":{"operationId":"finance_zuora_object_deleteinvoice","summary":"CRUD: Delete an invoice","description":"DELETE /v1/object/invoice/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postpayment":{"post":{"operationId":"finance_zuora_object_postpayment","summary":"CRUD: Create a payment","description":"POST /v1/object/payment","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postpayment-method":{"post":{"operationId":"finance_zuora_object_postpayment_method","summary":"CRUD: Create a payment method","description":"POST /v1/object/payment-method","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getpayment-method-snapshot":{"get":{"operationId":"finance_zuora_object_getpayment_method_snapshot","summary":"CRUD: Retrieve a payment method snapshot","description":"GET /v1/object/payment-method-snapshot/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getpayment-method-transaction-log":{"get":{"operationId":"finance_zuora_object_getpayment_method_transaction_log","summary":"CRUD: Retrieve a payment method transaction log","description":"GET /v1/object/payment-method-transaction-log/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getpayment-method":{"get":{"operationId":"finance_zuora_object_getpayment_method","summary":"CRUD: Retrieve a payment method","description":"GET /v1/object/payment-method/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putpayment-method":{"post":{"operationId":"finance_zuora_object_putpayment_method","summary":"CRUD: Update a payment method","description":"PUT /v1/object/payment-method/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletepayment-method":{"post":{"operationId":"finance_zuora_object_deletepayment_method","summary":"CRUD: Delete a payment method","description":"DELETE /v1/object/payment-method/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getpayment-transaction-log":{"get":{"operationId":"finance_zuora_object_getpayment_transaction_log","summary":"CRUD: Retrieve a payment transaction log","description":"GET /v1/object/payment-transaction-log/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"id","in":"query","required":true,"description":"The ID of a payment transaction log.","schema":{"type":"string","description":"The ID of a payment transaction log."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getpayment":{"get":{"operationId":"finance_zuora_object_getpayment","summary":"CRUD: Retrieve a payment","description":"GET /v1/object/payment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"id","in":"query","required":true,"description":"The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352.","schema":{"type":"string","description":"The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putpayment":{"post":{"operationId":"finance_zuora_object_putpayment","summary":"CRUD: Update a payment","description":"PUT /v1/object/payment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The unique ID of a payment. For example, 2c92c095592623ea01596621ada84352."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletepayment":{"post":{"operationId":"finance_zuora_object_deletepayment","summary":"CRUD: Delete a payment","description":"DELETE /v1/object/payment/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The unique ID of the payment to be deleted. For example, 2c92c0f85d4e95ae015d4f7e5d690622."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postproduct":{"post":{"operationId":"finance_zuora_object_postproduct","summary":"CRUD: Create a product","description":"POST /v1/object/product","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getproduct-feature":{"get":{"operationId":"finance_zuora_object_getproduct_feature","summary":"CRUD: Retrieve a product feature","description":"GET /v1/object/product-feature/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteproduct-feature":{"post":{"operationId":"finance_zuora_object_deleteproduct_feature","summary":"CRUD: Delete a product feature","description":"DELETE /v1/object/product-feature/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postproduct-rate-plan":{"post":{"operationId":"finance_zuora_object_postproduct_rate_plan","summary":"CRUD: Create a product rate plan","description":"POST /v1/object/product-rate-plan","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postproduct-rate-plan-charge":{"post":{"operationId":"finance_zuora_object_postproduct_rate_plan_charge","summary":"CRUD: Create a product rate plan charge","description":"POST /v1/object/product-rate-plan-charge","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getproduct-rate-plan-charge-tier":{"get":{"operationId":"finance_zuora_object_getproduct_rate_plan_charge_tier","summary":"CRUD: Retrieve a product rate plan charge tier","description":"GET /v1/object/product-rate-plan-charge-tier/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putproduct-rate-plan-charge-tier":{"post":{"operationId":"finance_zuora_object_putproduct_rate_plan_charge_tier","summary":"CRUD: Update a product rate plan charge tier","description":"PUT /v1/object/product-rate-plan-charge-tier/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The unique ID of the product rate plan charge tier to be updated. For example, 2c92c0f86c85891e016c88d55a6e543b."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getproduct-rate-plan-charge":{"get":{"operationId":"finance_zuora_object_getproduct_rate_plan_charge","summary":"CRUD: Retrieve a product rate plan charge","description":"GET /v1/object/product-rate-plan-charge/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19.","schema":{"type":"string","description":"The unique ID of a product rate plan charge to be retrieved. For example, 2c93808457d787030157e031fcd34e19."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putproduct-rate-plan-charge":{"post":{"operationId":"finance_zuora_object_putproduct_rate_plan_charge","summary":"CRUD: Update a product rate plan charge","description":"PUT /v1/object/product-rate-plan-charge/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"X-Zuora-WSDL-Version":{"type":"string","default":79,"description":"Zuora WSDL version number."},"id":{"type":"string","description":"The unique ID of the product rate plan charge to be updated. For example, 2c93808457d787030157e031fcd34e19."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteproduct-rate-plan-charge":{"post":{"operationId":"finance_zuora_object_deleteproduct_rate_plan_charge","summary":"CRUD: Delete a product rate plan charge","description":"DELETE /v1/object/product-rate-plan-charge/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The unique ID of the product rate plan charge to be deleted. For example, 2c93808457d787030157e031fcd34e19."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getproduct-rate-plan":{"get":{"operationId":"finance_zuora_object_getproduct_rate_plan","summary":"CRUD: Retrieve a product rate plan","description":"GET /v1/object/product-rate-plan/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putproduct-rate-plan":{"post":{"operationId":"finance_zuora_object_putproduct_rate_plan","summary":"CRUD: Update a product rate plan","description":"PUT /v1/object/product-rate-plan/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteproduct-rate-plan":{"post":{"operationId":"finance_zuora_object_deleteproduct_rate_plan","summary":"CRUD: Delete a product rate plan","description":"DELETE /v1/object/product-rate-plan/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getproduct":{"get":{"operationId":"finance_zuora_object_getproduct","summary":"CRUD: Retrieve a product","description":"GET /v1/object/product/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putproduct":{"post":{"operationId":"finance_zuora_object_putproduct","summary":"CRUD: Update a product","description":"PUT /v1/object/product/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteproduct":{"post":{"operationId":"finance_zuora_object_deleteproduct","summary":"CRUD: Delete a product","description":"DELETE /v1/object/product/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrate-plan-charge-tier":{"get":{"operationId":"finance_zuora_object_getrate_plan_charge_tier","summary":"CRUD: Retrieve a rate plan charge tier","description":"GET /v1/object/rate-plan-charge-tier/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrate-plan-charge":{"get":{"operationId":"finance_zuora_object_getrate_plan_charge","summary":"CRUD: Retrieve a rate plan charge","description":"GET /v1/object/rate-plan-charge/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putrate-plan-charge":{"post":{"operationId":"finance_zuora_object_putrate_plan_charge","summary":"CRUD: Update a rate plan charge","description":"PUT /v1/object/rate-plan-charge/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrate-plan":{"get":{"operationId":"finance_zuora_object_getrate_plan","summary":"CRUD: Retrieve a rate plan","description":"GET /v1/object/rate-plan/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postrefund":{"post":{"operationId":"finance_zuora_object_postrefund","summary":"CRUD: Create a refund","description":"POST /v1/object/refund","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrefund-invoice-payment":{"get":{"operationId":"finance_zuora_object_getrefund_invoice_payment","summary":"CRUD: Retrieve a refund invoice payment","description":"GET /v1/object/refund-invoice-payment/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrefund-transaction-log":{"get":{"operationId":"finance_zuora_object_getrefund_transaction_log","summary":"CRUD: Retrieve a refund transaction log","description":"GET /v1/object/refund-transaction-log/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getrefund":{"get":{"operationId":"finance_zuora_object_getrefund","summary":"CRUD: Retrieve a refund","description":"GET /v1/object/refund/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putrefund":{"post":{"operationId":"finance_zuora_object_putrefund","summary":"CRUD: Update a refund","description":"PUT /v1/object/refund/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleterefund":{"post":{"operationId":"finance_zuora_object_deleterefund","summary":"CRUD: Delete a refund","description":"DELETE /v1/object/refund/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getsubscription-product-feature":{"get":{"operationId":"finance_zuora_object_getsubscription_product_feature","summary":"CRUD: Retrieve a subscription product feature","description":"GET /v1/object/subscription-product-feature/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getsubscription":{"get":{"operationId":"finance_zuora_object_getsubscription","summary":"CRUD: Retrieve a subscription","description":"GET /v1/object/subscription/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"X-Zuora-WSDL-Version","in":"query","required":false,"description":"Zuora WSDL version number.","schema":{"type":"string","default":79,"description":"Zuora WSDL version number."}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putsubscription":{"post":{"operationId":"finance_zuora_object_putsubscription","summary":"CRUD: Update a subscription","description":"PUT /v1/object/subscription/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletesubscription":{"post":{"operationId":"finance_zuora_object_deletesubscription","summary":"CRUD: Delete a subscription","description":"DELETE /v1/object/subscription/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-posttaxation-item":{"post":{"operationId":"finance_zuora_object_posttaxation_item","summary":"CRUD: Create a taxation item","description":"POST /v1/object/taxation-item","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-gettaxation-item":{"get":{"operationId":"finance_zuora_object_gettaxation_item","summary":"CRUD: Retrieve a taxation item","description":"GET /v1/object/taxation-item/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-puttaxation-item":{"post":{"operationId":"finance_zuora_object_puttaxation_item","summary":"CRUD: Update a taxation item","description":"PUT /v1/object/taxation-item/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deletetaxation-item":{"post":{"operationId":"finance_zuora_object_deletetaxation_item","summary":"CRUD: Delete a taxation item","description":"DELETE /v1/object/taxation-item/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postunit-of-measure":{"post":{"operationId":"finance_zuora_object_postunit_of_measure","summary":"CRUD: Create a unit of measure","description":"POST /v1/object/unit-of-measure","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getunit-of-measure":{"get":{"operationId":"finance_zuora_object_getunit_of_measure","summary":"CRUD: Retrieve a unit of measure","description":"GET /v1/object/unit-of-measure/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putunit-of-measure":{"post":{"operationId":"finance_zuora_object_putunit_of_measure","summary":"CRUD: Update a unit of measure","description":"PUT /v1/object/unit-of-measure/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteunit-of-measure":{"post":{"operationId":"finance_zuora_object_deleteunit_of_measure","summary":"CRUD: Delete a unit of measure","description":"DELETE /v1/object/unit-of-measure/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-postusage":{"post":{"operationId":"finance_zuora_object_postusage","summary":"CRUD: Create a usage record","description":"POST /v1/object/usage","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-getusage":{"get":{"operationId":"finance_zuora_object_getusage","summary":"CRUD: Retrieve a usage record","description":"GET /v1/object/usage/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"fields","in":"query","required":false,"description":"Object fields to return","schema":{"type":"string","description":"Object fields to return"}},{"name":"id","in":"query","required":true,"description":"Object id","schema":{"type":"string","description":"Object id"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/object-putusage":{"post":{"operationId":"finance_zuora_object_putusage","summary":"CRUD: Update a usage record","description":"PUT /v1/object/usage/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"rejectUnknownFields":{"type":"boolean","default":false,"description":"Specifies whether the call fails if the request body contains unknown fields. With `rejectUnknownFields` set to `true`, Zuora returns a…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/object-deleteusage":{"post":{"operationId":"finance_zuora_object_deleteusage","summary":"CRUD: Delete a usage record","description":"DELETE /v1/object/usage/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"Object id"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-billing-preview":{"post":{"operationId":"finance_zuora_post_billing_preview","summary":"Generate a billing preview","description":"POST /v1/operations/billing-preview","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-transaction-invoice-payment":{"post":{"operationId":"finance_zuora_post_transaction_invoice_payment","summary":"Invoice and collect","description":"POST /v1/operations/invoice-collect","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * documentDate * targetDate If…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-order-line-items":{"post":{"operationId":"finance_zuora_post_order_line_items","summary":"Update order line items","description":"POST /v1/order-line-items/bulk","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-order-line-item":{"get":{"operationId":"finance_zuora_get_order_line_item","summary":"Retrieve an order line item","description":"GET /v1/order-line-items/{itemId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"itemId","in":"query","required":true,"description":"The id of the Order Line Item to retrieve.","schema":{"type":"string","description":"The id of the Order Line Item to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-order-line-item":{"post":{"operationId":"finance_zuora_put_order_line_item","summary":"Update an order line item","description":"PUT /v1/order-line-items/{itemId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["itemId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"itemId":{"type":"string","description":"The id of the Order Line Item to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-all-orders":{"get":{"operationId":"finance_zuora_get_all_orders","summary":"List orders","description":"GET /v1/orders","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"page","in":"query","required":false,"description":"The page number of the orders retrieved.","schema":{"type":"integer","default":1,"description":"The page number of the orders retrieved."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"dateFilterOption","in":"query","required":false,"description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.","schema":{"type":"string","description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate."}},{"name":"startDate","in":"query","required":false,"description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date."}},{"name":"endDate","in":"query","required":false,"description":"The result will only contains orders with the date of dateFilterOption earlier than or equal to this date.","schema":{"type":"string","description":"The result will only contains orders with the date of dateFilterOption earlier than or equal to this date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-order":{"post":{"operationId":"finance_zuora_post_order","summary":"Create an order","description":"POST /v1/orders","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"returnIds":{"type":"boolean","default":false,"description":"Specify whether to return IDs associated with the numbers returned in the \"Create an order\" operation."},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * subscriptions *…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-orders-by-invoice-owner":{"get":{"operationId":"finance_zuora_get_orders_by_invoice_owner","summary":"List orders of an invoice owner","description":"GET /v1/orders/invoiceOwner/{accountNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"accountNumber","in":"query","required":true,"description":"The invoice owner account number.","schema":{"type":"string","description":"The invoice owner account number."}},{"name":"page","in":"query","required":false,"description":"The page number of the orders retrieved. The default is 1.","schema":{"type":"integer","description":"The page number of the orders retrieved. The default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"dateFilterOption","in":"query","required":false,"description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate.","schema":{"type":"string","description":"The date type to filter on. This field value can be orderDate or updatedDate. Default is orderDate."}},{"name":"startDate","in":"query","required":false,"description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of dateFilterOption later than or equal to this date."}},{"name":"endDate","in":"query","required":false,"description":"The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of dateFilterOption earlier than or equal to this date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-preview-order":{"post":{"operationId":"finance_zuora_post_preview_order","summary":"Preview an order","description":"POST /v1/orders/preview","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-orders-by-subscription-number":{"get":{"operationId":"finance_zuora_get_orders_by_subscription_number","summary":"List orders by subscription number","description":"GET /v1/orders/subscription/{subscriptionNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"subscriptionNumber","in":"query","required":true,"description":"The subscription number.","schema":{"type":"string","description":"The subscription number."}},{"name":"page","in":"query","required":false,"description":"The page number of the orders retrieved. The default is '1'.","schema":{"type":"integer","description":"The page number of the orders retrieved. The default is '1'."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"dateFilterOption","in":"query","required":false,"description":"The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.","schema":{"type":"string","description":"The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate."}},{"name":"startDate","in":"query","required":false,"description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date."}},{"name":"endDate","in":"query","required":false,"description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-orders-by-subscription-owner":{"get":{"operationId":"finance_zuora_get_orders_by_subscription_owner","summary":"List orders of a subscription owner","description":"GET /v1/orders/subscriptionOwner/{accountNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"accountNumber","in":"query","required":true,"description":"The subscription owner account number.","schema":{"type":"string","description":"The subscription owner account number."}},{"name":"page","in":"query","required":false,"description":"The page number of the orders retrieved. The default is 1.","schema":{"type":"integer","description":"The page number of the orders retrieved. The default is 1."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"dateFilterOption","in":"query","required":false,"description":"The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate.","schema":{"type":"string","description":"The date type to filter on. This field value can be 'orderDate' or 'updatedDate'. Default is orderDate."}},{"name":"startDate","in":"query","required":false,"description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of 'dateFilterOption' later than or equal to this date."}},{"name":"endDate","in":"query","required":false,"description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date.","schema":{"type":"string","description":"The result will only contain the orders with the date of 'dateFilterOption' earlier than or equal to this date."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-subscription-term-info":{"get":{"operationId":"finance_zuora_get_subscription_term_info","summary":"List subscription terms","description":"GET /v1/orders/term/{subscriptionNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"subscriptionNumber","in":"query","required":true,"description":"The number of the subscription to retrieve terms for. For example, A-S00000001.","schema":{"type":"string","description":"The number of the subscription to retrieve terms for. For example, A-S00000001."}},{"name":"version","in":"query","required":false,"description":"The version of the subscription to retrieve terms for. If you do not specify this parameter, Zuora returns the terms for the latest…","schema":{"type":"integer","description":"The version of the subscription to retrieve terms for. If you do not specify this parameter, Zuora returns the terms for the latest…"}},{"name":"page","in":"query","required":false,"description":"The page number of the terms retrieved.","schema":{"type":"integer","default":1,"description":"The page number of the terms retrieved."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-order":{"get":{"operationId":"finance_zuora_get_order","summary":"Retrieve an order","description":"GET /v1/orders/{orderNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"orderNumber","in":"query","required":true,"description":"The order number to be retrieved.","schema":{"type":"string","description":"The order number to be retrieved."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-order":{"post":{"operationId":"finance_zuora_delete_order","summary":"Delete an order","description":"DELETE /v1/orders/{orderNumber}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderNumber"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"orderNumber":{"type":"string","description":"The number of the order to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-order-custom-fields":{"post":{"operationId":"finance_zuora_put_update_order_custom_fields","summary":"Update order custom fields","description":"PUT /v1/orders/{orderNumber}/customFields","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderNumber","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"orderNumber":{"type":"string","description":"The order number."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-order-metricsfor-evergreen-subscription":{"get":{"operationId":"finance_zuora_get_order_metricsfor_evergreen_subscription","summary":"List order metrics for an evergreen subscription","description":"GET /v1/orders/{orderNumber}/evergreenMetrics/{subscriptionNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"orderNumber","in":"query","required":true,"description":"The order number.","schema":{"type":"string","description":"The order number."}},{"name":"subscriptionNumber","in":"query","required":true,"description":"The subscription number you want to get the metrics for.","schema":{"type":"string","description":"The subscription number you want to get the metrics for."}},{"name":"startDate","in":"query","required":true,"description":"The start date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03.","schema":{"type":"string","description":"The start date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03."}},{"name":"endDate","in":"query","required":true,"description":"The end date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03.","schema":{"type":"string","description":"The end date of the date range for which you want to get the metrics. The date must be in yyyy-mm-dd format. For example, 2017-12-03."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-ramp-metrics-by-order-number":{"get":{"operationId":"finance_zuora_get_ramp_metrics_by_order_number","summary":"List ramp metrics by order number","description":"GET /v1/orders/{orderNumber}/ramp-metrics","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"orderNumber","in":"query","required":true,"description":"The number of the existing order.","schema":{"type":"string","description":"The number of the existing order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-order-trigger-dates":{"post":{"operationId":"finance_zuora_put_order_trigger_dates","summary":"Update order action trigger dates","description":"PUT /v1/orders/{orderNumber}/triggerDates","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["orderNumber","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"orderNumber":{"type":"string","description":"Order number of a pending order in which you are to update an order action's triggering dates."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-payment-methods":{"post":{"operationId":"finance_zuora_post_payment_methods","summary":"Create a payment method","description":"POST /v1/payment-methods","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-payment-methods-credit-card":{"post":{"operationId":"finance_zuora_post_payment_methods_credit_card","summary":"Create a credit card payment method","description":"POST /v1/payment-methods/credit-cards","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-methods-credit-card":{"get":{"operationId":"finance_zuora_get_payment_methods_credit_card","summary":"List all credit card payment methods of an account","description":"GET /v1/payment-methods/credit-cards/accounts/{account-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"account-key","in":"query","required":true,"description":"Account number or account ID.","schema":{"type":"string","description":"Account number or account ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-payment-methods-credit-card":{"post":{"operationId":"finance_zuora_put_payment_methods_credit_card","summary":"Update a credit card payment method","description":"PUT /v1/payment-methods/credit-cards/{payment-method-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"Unique ID of the payment method to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-payment-methods-decryption":{"post":{"operationId":"finance_zuora_post_payment_methods_decryption","summary":"Create an Apple Pay payment method","description":"POST /v1/payment-methods/decryption","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-method":{"get":{"operationId":"finance_zuora_get_payment_method","summary":"Retrieve a payment method","description":"GET /v1/payment-methods/{payment-method-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"payment-method-id","in":"query","required":true,"description":"Unique ID of the payment method to update.","schema":{"type":"string","description":"Unique ID of the payment method to update."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-payment-method":{"post":{"operationId":"finance_zuora_put_payment_method","summary":"Update a payment method","description":"PUT /v1/payment-methods/{payment-method-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"Unique ID of the payment method to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-payment-methods":{"post":{"operationId":"finance_zuora_delete_payment_methods","summary":"Delete a payment method","description":"DELETE /v1/payment-methods/{payment-method-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"Unique identifier of a payment method. (Since this ID is unique, and linked to a customer account in the system, no customer identifier is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-authorization":{"post":{"operationId":"finance_zuora_post_create_authorization","summary":"Create authorization","description":"POST /v1/payment-methods/{payment-method-id}/authorize","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"The unique ID of the payment method where the authorization is created."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-stored-credential-profiles":{"get":{"operationId":"finance_zuora_get_stored_credential_profiles","summary":"List stored credential profiles of a payment method","description":"GET /v1/payment-methods/{payment-method-id}/profiles","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"payment-method-id","in":"query","required":true,"description":"ID of a payment method.","schema":{"type":"string","description":"ID of a payment method."}},{"name":"includeAll","in":"query","required":false,"description":"Specifies whether to retrieve all the stored credential profiles within the payment method. By default, Zuora returns only the stored…","schema":{"type":"boolean","default":false,"description":"Specifies whether to retrieve all the stored credential profiles within the payment method. By default, Zuora returns only the stored…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-stored-credential-profile":{"post":{"operationId":"finance_zuora_post_create_stored_credential_profile","summary":"Create a stored credential profile","description":"POST /v1/payment-methods/{payment-method-id}/profiles","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"ID of a payment method."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-cancel-stored-credential-profile":{"post":{"operationId":"finance_zuora_post_cancel_stored_credential_profile","summary":"Cancel a stored credential profile","description":"POST /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","profile-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"ID of a payment method."},"profile-number":{"type":"integer","description":"Number that identifies a stored credential profile within the payment method."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-expire-stored-credential-profile":{"post":{"operationId":"finance_zuora_post_expire_stored_credential_profile","summary":"Expire a stored credential profile","description":"POST /v1/payment-methods/{payment-method-id}/profiles/{profile-number}/expire","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","profile-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"ID of a payment method."},"profile-number":{"type":"integer","description":"Number that identifies a stored credential profile within the payment method."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-scrub-payment-methods":{"post":{"operationId":"finance_zuora_put_scrub_payment_methods","summary":"Scrub a payment method","description":"PUT /v1/payment-methods/{payment-method-id}/scrub","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"The ID of the payment method where you want to scrub the sensitive data."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-verify-payment-methods":{"post":{"operationId":"finance_zuora_put_verify_payment_methods","summary":"Verify a payment method","description":"PUT /v1/payment-methods/{payment-method-id}/verify","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"payment-method-id":{"type":"string","description":"The ID of the payment method to be verified."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-cancel-authorization":{"post":{"operationId":"finance_zuora_post_cancel_authorization","summary":"Cancel authorization","description":"POST /v1/payment-methods/{payment-method-id}/voidAuthorize","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment-method-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"payment-method-id":{"type":"string","description":"The unique ID of the payment method where the authorization is cancelled."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-runs":{"get":{"operationId":"finance_zuora_get_payment_runs","summary":"List payment runs","description":"GET /v1/payment-runs","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"status","in":"query","required":false,"description":"This parameter filters the response based on the `status` field.","schema":{"type":"string","enum":["Pending","Processing","Completed","Error","Canceled"],"description":"This parameter filters the response based on the `status` field."}},{"name":"targetDate","in":"query","required":false,"description":"This parameter filters the response based on the `targetDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `targetDate` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-payment-run":{"post":{"operationId":"finance_zuora_post_payment_run","summary":"Create a payment run","description":"POST /v1/payment-runs","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-run":{"get":{"operationId":"finance_zuora_get_payment_run","summary":"Retrieve a payment run","description":"GET /v1/payment-runs/{paymentRunId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"paymentRunId","in":"query","required":true,"description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566.","schema":{"type":"string","description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-payment-run":{"post":{"operationId":"finance_zuora_put_payment_run","summary":"Update a payment run","description":"PUT /v1/payment-runs/{paymentRunId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentRunId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentRunId":{"type":"string","description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-payment-run":{"post":{"operationId":"finance_zuora_delete_payment_run","summary":"Delete a payment run","description":"DELETE /v1/payment-runs/{paymentRunId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentRunId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"paymentRunId":{"type":"string","description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-run-data":{"get":{"operationId":"finance_zuora_get_payment_run_data","summary":"Retrieve payment run data","description":"GET /v1/payment-runs/{paymentRunId}/data","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"paymentRunId","in":"query","required":true,"description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566.","schema":{"type":"string","description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-run-summary":{"get":{"operationId":"finance_zuora_get_payment_run_summary","summary":"Retrieve a payment run summary","description":"GET /v1/payment-runs/{paymentRunId}/summary","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"paymentRunId","in":"query","required":true,"description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566.","schema":{"type":"string","description":"The unique ID of a payment run. For example, 402890245f097f39015f0f074a2e0566."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-paymentgateways":{"get":{"operationId":"finance_zuora_get_paymentgateways","summary":"List all payment gateways","description":"GET /v1/paymentgateways","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-retrieve-all-payments":{"get":{"operationId":"finance_zuora_get_retrieve_all_payments","summary":"List payments","description":"GET /v1/payments","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"accountId","in":"query","required":false,"description":"This parameter filters the response based on the `accountId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `accountId` field."}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"appliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `appliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `appliedAmount` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"creditBalanceAmount","in":"query","required":false,"description":"This parameter filters the response based on the `creditBalanceAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `creditBalanceAmount` field."}},{"name":"currency","in":"query","required":false,"description":"This parameter filters the response based on the `currency` field.","schema":{"type":"string","description":"This parameter filters the response based on the `currency` field."}},{"name":"effectiveDate","in":"query","required":false,"description":"This parameter filters the response based on the `effectiveDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `effectiveDate` field."}},{"name":"number","in":"query","required":false,"description":"This parameter filters the response based on the `number` field.","schema":{"type":"string","description":"This parameter filters the response based on the `number` field."}},{"name":"refundAmount","in":"query","required":false,"description":"This parameter filters the response based on the `refundAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `refundAmount` field."}},{"name":"status","in":"query","required":false,"description":"This parameter filters the response based on the `status` field.","schema":{"type":"string","enum":["Draft","Processing","Processed","Error","Canceled","Posted"],"description":"This parameter filters the response based on the `status` field."}},{"name":"type","in":"query","required":false,"description":"This parameter filters the response based on the `type` field.","schema":{"type":"string","enum":["External","Electronic"],"description":"This parameter filters the response based on the `type` field."}},{"name":"unappliedAmount","in":"query","required":false,"description":"This parameter filters the response based on the `unappliedAmount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `unappliedAmount` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-create-payment":{"post":{"operationId":"finance_zuora_post_create_payment","summary":"Create a payment","description":"POST /v1/payments","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment":{"get":{"operationId":"finance_zuora_get_payment","summary":"Retrieve a payment","description":"GET /v1/payments/{paymentId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"paymentId","in":"query","required":true,"description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.","schema":{"type":"string","description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-payment":{"post":{"operationId":"finance_zuora_put_update_payment","summary":"Update a payment","description":"PUT /v1/payments/{paymentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-payment":{"post":{"operationId":"finance_zuora_delete_payment","summary":"Delete a payment","description":"DELETE /v1/payments/{paymentId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-apply-payment":{"post":{"operationId":"finance_zuora_put_apply_payment","summary":"Apply a payment","description":"PUT /v1/payments/{paymentId}/apply","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-cancel-payment":{"post":{"operationId":"finance_zuora_put_cancel_payment","summary":"Cancel a payment","description":"PUT /v1/payments/{paymentId}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-parts":{"get":{"operationId":"finance_zuora_get_payment_parts","summary":"List all parts of a payment","description":"GET /v1/payments/{paymentId}/parts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"paymentId","in":"query","required":true,"description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.","schema":{"type":"string","description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-part":{"get":{"operationId":"finance_zuora_get_payment_part","summary":"Retrieve a payment part","description":"GET /v1/payments/{paymentId}/parts/{partid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…"}},{"name":"paymentId","in":"query","required":true,"description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.","schema":{"type":"string","description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-item-parts":{"get":{"operationId":"finance_zuora_get_payment_item_parts","summary":"List all payment part items","description":"GET /v1/payments/{paymentId}/parts/{partid}/itemparts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…"}},{"name":"paymentId","in":"query","required":true,"description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.","schema":{"type":"string","description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-payment-item-part":{"get":{"operationId":"finance_zuora_get_payment_item_part","summary":"Retrieve a payment part item","description":"GET /v1/payments/{paymentId}/parts/{partid}/itemparts/{itempartid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"partid","in":"query","required":true,"description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific payment part. You can get the payment part ID from the response of [List all parts of a…"}},{"name":"itempartid","in":"query","required":true,"description":"The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part…","schema":{"type":"string","description":"The unique ID of a specific payment part item. You can get the payment part item ID from the response of [List all payment part…"}},{"name":"paymentId","in":"query","required":true,"description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1.","schema":{"type":"string","description":"The unique ID of a payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-refund-payment":{"post":{"operationId":"finance_zuora_post_refund_payment","summary":"Refund a payment","description":"POST /v1/payments/{paymentId}/refunds","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-transfer-payment":{"post":{"operationId":"finance_zuora_put_transfer_payment","summary":"Transfer a payment","description":"PUT /v1/payments/{paymentId}/transfer","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an unapplied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-unapply-payment":{"post":{"operationId":"finance_zuora_put_unapply_payment","summary":"Unapply a payment","description":"PUT /v1/payments/{paymentId}/unapply","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["paymentId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"paymentId":{"type":"string","description":"The unique ID of an applied payment. For example, 8a8082e65b27f6c3015b89e4344c16b1."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-quotes-document":{"post":{"operationId":"finance_zuora_post_quotes_document","summary":"Generate a quote document","description":"POST /v1/quotes/document","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-ramp-by-ramp-number":{"get":{"operationId":"finance_zuora_get_ramp_by_ramp_number","summary":"Retrieve a ramp","description":"GET /v1/ramps/{rampNumber}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"rampNumber","in":"query","required":true,"description":"The automatically generated number of a ramp. For example, R-00000268.","schema":{"type":"string","description":"The automatically generated number of a ramp. For example, R-00000268."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-ramp-metrics-by-ramp-number":{"get":{"operationId":"finance_zuora_get_ramp_metrics_by_ramp_number","summary":"List all ramp metrics of a ramp","description":"GET /v1/ramps/{rampNumber}/ramp-metrics","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"rampNumber","in":"query","required":true,"description":"The automatically generated number of a ramp. For example, R-00000268.","schema":{"type":"string","description":"The automatically generated number of a ramp. For example, R-00000268."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-product-rate-plans":{"get":{"operationId":"finance_zuora_get_product_rate_plans","summary":"List all product rate plans of a product","description":"GET /v1/rateplan/{product_id}/productRatePlan","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"product_id","in":"query","required":true,"description":"The unique ID of a product. For example, 2c92c0f96487e16a016487f663c71a61.","schema":{"type":"string","description":"The unique ID of a product. For example, 2c92c0f96487e16a016487f663c71a61."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refunds":{"get":{"operationId":"finance_zuora_get_refunds","summary":"List refunds","description":"GET /v1/refunds","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"accountId","in":"query","required":false,"description":"This parameter filters the response based on the `accountId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `accountId` field."}},{"name":"amount","in":"query","required":false,"description":"This parameter filters the response based on the `amount` field.","schema":{"type":"number","description":"This parameter filters the response based on the `amount` field."}},{"name":"createdById","in":"query","required":false,"description":"This parameter filters the response based on the `createdById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdById` field."}},{"name":"createdDate","in":"query","required":false,"description":"This parameter filters the response based on the `createdDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `createdDate` field."}},{"name":"methodType","in":"query","required":false,"description":"This parameter filters the response based on the `methodType` field.","schema":{"type":"string","enum":["ACH","Cash","Check","CreditCard","PayPal","WireTransfer","DebitCard","CreditCardReferenceTransaction","BankTransfer","Other"],"description":"This parameter filters the response based on the `methodType` field."}},{"name":"number","in":"query","required":false,"description":"This parameter filters the response based on the `number` field.","schema":{"type":"string","description":"This parameter filters the response based on the `number` field."}},{"name":"paymentId","in":"query","required":false,"description":"This parameter filters the response based on the `paymentId` field.","schema":{"type":"string","description":"This parameter filters the response based on the `paymentId` field."}},{"name":"refundDate","in":"query","required":false,"description":"This parameter filters the response based on the `refundDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `refundDate` field."}},{"name":"status","in":"query","required":false,"description":"This parameter filters the response based on the `status` field.","schema":{"type":"string","enum":["Processed","Canceled","Error","Processing"],"description":"This parameter filters the response based on the `status` field."}},{"name":"type","in":"query","required":false,"description":"This parameter filters the response based on the `type` field.","schema":{"type":"string","enum":["External","Electronic"],"description":"This parameter filters the response based on the `type` field."}},{"name":"updatedById","in":"query","required":false,"description":"This parameter filters the response based on the `updatedById` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedById` field."}},{"name":"updatedDate","in":"query","required":false,"description":"This parameter filters the response based on the `updatedDate` field.","schema":{"type":"string","description":"This parameter filters the response based on the `updatedDate` field."}},{"name":"sort","in":"query","required":false,"description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…","schema":{"type":"string","description":"This parameter restricts the order of the data returned in the response. You can use this parameter to supply a dimension you want to sort…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-reconcile-refund":{"post":{"operationId":"finance_zuora_post_reconcile_refund","summary":"Reconcile a refund","description":"POST /v1/refunds/{refund-id}/reconcile","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refund-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"refund-id":{"type":"string","description":"Unique ID of the refund."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refund":{"get":{"operationId":"finance_zuora_get_refund","summary":"Retrieve a refund","description":"GET /v1/refunds/{refundId}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"refundId","in":"query","required":true,"description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.","schema":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-update-refund":{"post":{"operationId":"finance_zuora_put_update_refund","summary":"Update a refund","description":"PUT /v1/refunds/{refundId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refundId","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"refundId":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-refund":{"post":{"operationId":"finance_zuora_delete_refund","summary":"Delete a refund","description":"DELETE /v1/refunds/{refundId}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refundId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"refundId":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-cancel-refund":{"post":{"operationId":"finance_zuora_put_cancel_refund","summary":"Cancel a refund","description":"PUT /v1/refunds/{refundId}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refundId"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"refundId":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refund-parts":{"get":{"operationId":"finance_zuora_get_refund_parts","summary":"List all parts of a refund","description":"GET /v1/refunds/{refundId}/parts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"refundId","in":"query","required":true,"description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.","schema":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refund-part":{"get":{"operationId":"finance_zuora_get_refund_part","summary":"Retrieve a refund part","description":"GET /v1/refunds/{refundId}/parts/{refundpartid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"refundpartid","in":"query","required":true,"description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…"}},{"name":"refundId","in":"query","required":true,"description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.","schema":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refund-item-parts":{"get":{"operationId":"finance_zuora_get_refund_item_parts","summary":"List all refund part items","description":"GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"refundpartid","in":"query","required":true,"description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…"}},{"name":"refundId","in":"query","required":true,"description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.","schema":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-refund-item-part":{"get":{"operationId":"finance_zuora_get_refund_item_part","summary":"Retrieve a refund part item","description":"GET /v1/refunds/{refundId}/parts/{refundpartid}/itemparts/{itempartid}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"itempartid","in":"query","required":true,"description":"The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part…","schema":{"type":"string","description":"The unique ID of a specific refund part item. You can get the refund part item ID from the response of [Get refund part…"}},{"name":"refundpartid","in":"query","required":true,"description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…","schema":{"type":"string","description":"The unique ID of a specific refund part. You can get the refund part ID from the response of [List all parts of a…"}},{"name":"refundId","in":"query","required":true,"description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9.","schema":{"type":"string","description":"The unique ID of a refund. For example, 4028905f5a87c0ff015a889e590e00c9."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-event-for-revenue-schedule":{"get":{"operationId":"finance_zuora_get_revenue_event_for_revenue_schedule","summary":"List all revenue events of a revenue schedule","description":"GET /v1/revenue-events/revenue-schedules/{rs-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":8,"description":"Number of rows returned per page."}},{"name":"rs-number","in":"query","required":true,"description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\".","schema":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-event-details":{"get":{"operationId":"finance_zuora_get_revenue_event_details","summary":"Retrieve a revenue event","description":"GET /v1/revenue-events/{event-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"event-number","in":"query","required":true,"description":"The number associated with the revenue event.","schema":{"type":"string","description":"The number associated with the revenue event."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-items-by-charge-revenue-summary-number":{"get":{"operationId":"finance_zuora_get_revenue_items_by_charge_revenue_summary_number","summary":"List revenue items by charge revenue summary number","description":"GET /v1/revenue-items/charge-revenue-summaries/{crs-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":300,"description":"Number of rows returned per page."}},{"name":"crs-number","in":"query","required":true,"description":"The charge revenue summary number.","schema":{"type":"string","description":"The charge revenue summary number."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-items-by-charge-revenue-event-number":{"get":{"operationId":"finance_zuora_get_revenue_items_by_charge_revenue_event_number","summary":"List revenue items by revenue event number","description":"GET /v1/revenue-items/revenue-events/{event-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":300,"description":"Number of rows returned per page."}},{"name":"event-number","in":"query","required":true,"description":"The number associated with the revenue event.","schema":{"type":"string","description":"The number associated with the revenue event."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-custom-fieldson-revenue-items-by-revenue-event":{"post":{"operationId":"finance_zuora_put_custom_fieldson_revenue_items_by_revenue_event","summary":"Update custom fields on revenue items by revenue event number","description":"PUT /v1/revenue-items/revenue-events/{event-number}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["event-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"event-number":{"type":"string","description":"The number associated with the revenue event."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-items-by-revenue-schedule":{"get":{"operationId":"finance_zuora_get_revenue_items_by_revenue_schedule","summary":"List all revenue items of a revenue schedule","description":"GET /v1/revenue-items/revenue-schedules/{rs-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":300,"description":"Number of rows returned per page."}},{"name":"rs-number","in":"query","required":true,"description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\".","schema":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-custom-fieldson-revenue-items-by-revenue-schedule":{"post":{"operationId":"finance_zuora_put_custom_fieldson_revenue_items_by_revenue_schedule","summary":"Update custom fields on revenue items by revenue schedule number","description":"PUT /v1/revenue-items/revenue-schedules/{rs-number}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-rec-ruleby-product-rate-plan-charge":{"get":{"operationId":"finance_zuora_get_revenue_rec_ruleby_product_rate_plan_charge","summary":"Retrieve a revenue recognition rule by product rate plan charge ID","description":"GET /v1/revenue-recognition-rules/product-charges/{charge-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"charge-key","in":"query","required":true,"description":"The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82.","schema":{"type":"string","description":"The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-rec-rules":{"get":{"operationId":"finance_zuora_get_revenue_rec_rules","summary":"Retrieve a revenue recognition rule by subscription charge ID","description":"GET /v1/revenue-recognition-rules/subscription-charges/{charge-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"charge-key","in":"query","required":true,"description":"The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012.","schema":{"type":"string","description":"The unique ID of the subscription rate plan charge. For example, 402892793e173340013e173b81000012."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsby-credit-memo-item":{"get":{"operationId":"finance_zuora_get_rsby_credit_memo_item","summary":"Retrieve a revenue schedule by credit memo item ID","description":"GET /v1/revenue-schedules/credit-memo-items/{cmi-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"cmi-id","in":"query","required":true,"description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo…","schema":{"type":"string","description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-credit-memo-item-manual-distribution":{"post":{"operationId":"finance_zuora_post_rsfor_credit_memo_item_manual_distribution","summary":"Create a revenue schedule for a credit memo item (manual distribution)","description":"POST /v1/revenue-schedules/credit-memo-items/{cmi-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cmi-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"cmi-id":{"type":"string","description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-credit-memo-item-distribute-by-date-range":{"post":{"operationId":"finance_zuora_post_rsfor_credit_memo_item_distribute_by_date_range","summary":"Create a revenue schedule for a credit memo item (distribute by date range)","description":"POST /v1/revenue-schedules/credit-memo-items/{cmi-id}/distribute-revenue-with-date-range","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cmi-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"cmi-id":{"type":"string","description":"The unique ID of a credit memo item. You can get the credit memo item ID from the response of [Get credit memo…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsby-debit-memo-item":{"get":{"operationId":"finance_zuora_get_rsby_debit_memo_item","summary":"Retrieve a revenue schedule by debit memo item ID","description":"GET /v1/revenue-schedules/debit-memo-items/{dmi-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"dmi-id","in":"query","required":true,"description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo…","schema":{"type":"string","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-debit-memo-item-manual-distribution":{"post":{"operationId":"finance_zuora_post_rsfor_debit_memo_item_manual_distribution","summary":"Create a revenue schedule for a debit memo item (distribute by date range)","description":"POST /v1/revenue-schedules/debit-memo-items/{dmi-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dmi-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"dmi-id":{"type":"string","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-debit-memo-item-distribute-by-date-range":{"post":{"operationId":"finance_zuora_post_rsfor_debit_memo_item_distribute_by_date_range","summary":"Create a revenue schedule for a debit memo item (distribute by date range)","description":"POST /v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["dmi-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"dmi-id":{"type":"string","description":"The unique ID of a debit memo item. You can get the debit memo item ID from the response of [Get debit memo…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsby-invoice-item-adjustment":{"get":{"operationId":"finance_zuora_get_rsby_invoice_item_adjustment","summary":"Retrieve a revenue schedule by invoice item adjustment key","description":"GET /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"invoice-item-adj-key","in":"query","required":true,"description":"ID of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72.","schema":{"type":"string","description":"ID of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-invoice-item-adjustment-manual-distribution":{"post":{"operationId":"finance_zuora_post_rsfor_invoice_item_adjustment_manual_distribution","summary":"Create a revenue schedule for an invoice item adjustment (manual distribution)","description":"POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoice-item-adj-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoice-item-adj-key":{"type":"string","description":"ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-invoice-item-adjustment-distribute-by-date-range":{"post":{"operationId":"finance_zuora_post_rsfor_invoice_item_adjustment_distribute_by_date_range","summary":"Create a revenue schedule for an invoice item adjustment (distribute by date range)","description":"POST /v1/revenue-schedules/invoice-item-adjustments/{invoice-item-adj-key}/distribute-revenue-with-date-range","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoice-item-adj-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoice-item-adj-key":{"type":"string","description":"ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72. If the specified Invoice Item Adjustment is…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsby-invoice-item":{"get":{"operationId":"finance_zuora_get_rsby_invoice_item","summary":"Retrieve a revenue schedule by invoice item ID","description":"GET /v1/revenue-schedules/invoice-items/{invoice-item-id}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"invoice-item-id","in":"query","required":true,"description":"A valid Invoice Item ID.","schema":{"type":"string","description":"A valid Invoice Item ID."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-invoice-item-manual-distribution":{"post":{"operationId":"finance_zuora_post_rsfor_invoice_item_manual_distribution","summary":"Create a revenue schedule for an invoice item (manual distribution)","description":"POST /v1/revenue-schedules/invoice-items/{invoice-item-id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoice-item-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoice-item-id":{"type":"string","description":"ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-invoice-item-distribute-by-date-range":{"post":{"operationId":"finance_zuora_post_rsfor_invoice_item_distribute_by_date_range","summary":"Create a revenue schedule for an invoice item (distribute by date range)","description":"POST /v1/revenue-schedules/invoice-items/{invoice-item-id}/distribute-revenue-with-date-range","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoice-item-id","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"invoice-item-id":{"type":"string","description":"ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsby-product-charge-and-billing-account":{"get":{"operationId":"finance_zuora_get_rsby_product_charge_and_billing_account","summary":"List revenue schedules of a product charge by charge ID and account key","description":"GET /v1/revenue-schedules/product-charges/{charge-key}/{account-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":8,"description":"Number of rows returned per page."}},{"name":"account-key","in":"query","required":true,"description":"The account number or account ID.","schema":{"type":"string","description":"The account number or account ID."}},{"name":"charge-key","in":"query","required":true,"description":"The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82.","schema":{"type":"string","description":"The unique ID of a product rate plan charge. For example, 8a8082e65ba86084015bb323d3c61d82."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rsfor-subsc-charge":{"get":{"operationId":"finance_zuora_get_rsfor_subsc_charge","summary":"List revenue schedules by subscription charge key","description":"GET /v1/revenue-schedules/subscription-charges/{charge-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":8,"description":"Number of rows returned per page."}},{"name":"charge-key","in":"query","required":true,"description":"ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.","schema":{"type":"string","description":"ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsfor-subsc-charge":{"post":{"operationId":"finance_zuora_post_rsfor_subsc_charge","summary":"Create a revenue schedule by subscription charge key","description":"POST /v1/revenue-schedules/subscription-charges/{charge-key}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["charge-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"charge-key":{"type":"string","description":"ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-rs":{"get":{"operationId":"finance_zuora_get_rs","summary":"List all details of a revenue schedule","description":"GET /v1/revenue-schedules/{rs-number}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"rs-number","in":"query","required":true,"description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\".","schema":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-rs":{"post":{"operationId":"finance_zuora_delete_rs","summary":"Delete a revenue schedule","description":"DELETE /v1/revenue-schedules/{rs-number}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256. To be deleted, the revenue schedule: * Must…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-rsbasic-info":{"post":{"operationId":"finance_zuora_put_rsbasic_info","summary":"Update a revenue schedule","description":"PUT /v1/revenue-schedules/{rs-number}/basic-information","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-revenue-across-ap":{"post":{"operationId":"finance_zuora_put_revenue_across_ap","summary":"Distribute revenue across accounting periods","description":"PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-revenue-specific-date":{"post":{"operationId":"finance_zuora_put_revenue_specific_date","summary":"Distribute revenue on a specific date","description":"PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-on-specific-date","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number. The revenue schedule number is always prefixed with \"RS\", for example, \"RS-00000001\"."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-revenue-by-recognition-startand-end-dates":{"post":{"operationId":"finance_zuora_put_revenue_by_recognition_startand_end_dates","summary":"Distribute revenue in a recognition period","description":"PUT /v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rs-number","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"rs-number":{"type":"string","description":"Revenue schedule number. Specify the revenue schedule whose revenue you want to distribute. The revenue schedule number is always prefixed…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-rev-pro-accounting-codes":{"post":{"operationId":"finance_zuora_put_rev_pro_accounting_codes","summary":"Update a Zuora Revenue accounting code","description":"PUT /v1/revpro-accounting-codes","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-rsasignatures":{"post":{"operationId":"finance_zuora_post_rsasignatures","summary":"Generate an RSA signature","description":"POST /v1/rsa-signatures","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/post-decrypt-rsasignatures":{"post":{"operationId":"finance_zuora_post_decrypt_rsasignatures","summary":"Decrypt an RSA signature","description":"POST /v1/rsa-signatures/decrypt","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-sequence-sets":{"get":{"operationId":"finance_zuora_get_sequence_sets","summary":"List sequence sets","description":"GET /v1/sequence-sets","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"page","in":"query","required":false,"description":"Page number.","schema":{"type":"integer","default":1,"description":"Page number."}},{"name":"name","in":"query","required":false,"description":"The name of a specific sequence set.","schema":{"type":"string","description":"The name of a specific sequence set."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-sequence-sets":{"post":{"operationId":"finance_zuora_post_sequence_sets","summary":"Create sequence sets","description":"POST /v1/sequence-sets","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-sequence-set":{"get":{"operationId":"finance_zuora_get_sequence_set","summary":"Retrieve a sequence set","description":"GET /v1/sequence-sets/{id}","tags":["finance"],"parameters":[{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"id","in":"query","required":true,"description":"The ID of the sequence set to retrieve information about.","schema":{"type":"string","description":"The ID of the sequence set to retrieve information about."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-sequence-set":{"post":{"operationId":"finance_zuora_put_sequence_set","summary":"Update a sequence set","description":"PUT /v1/sequence-sets/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The ID of the sequence set to update."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/delete-sequence-set":{"post":{"operationId":"finance_zuora_delete_sequence_set","summary":"Delete a sequence set","description":"DELETE /v1/sequence-sets/{id}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"id":{"type":"string","description":"The ID of the sequence set to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-revenue-automation-start-date":{"get":{"operationId":"finance_zuora_get_revenue_automation_start_date","summary":"Retrieve a revenue automation start date","description":"GET /v1/settings/finance/revenue-automation-start-date","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-subscription":{"post":{"operationId":"finance_zuora_post_subscription","summary":"Create a subscription","description":"POST /v1/subscriptions","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-subscriptions-by-account":{"get":{"operationId":"finance_zuora_get_subscriptions_by_account","summary":"List subscriptions by account key","description":"GET /v1/subscriptions/accounts/{account-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"pageSize","in":"query","required":false,"description":"Number of rows returned per page.","schema":{"type":"integer","default":20,"description":"Number of rows returned per page."}},{"name":"account-key","in":"query","required":true,"description":"Possible values are: * an account number * an account ID","schema":{"type":"string","description":"Possible values are: * an account number * an account ID"}},{"name":"charge-detail","in":"query","required":false,"description":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this…","schema":{"type":"string","description":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/post-preview-subscription":{"post":{"operationId":"finance_zuora_post_preview_subscription","summary":"Preview a subscription","description":"POST /v1/subscriptions/preview","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * targetDate *…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/get-subscriptions-by-key":{"get":{"operationId":"finance_zuora_get_subscriptions_by_key","summary":"Retrieve a subscription by key","description":"GET /v1/subscriptions/{subscription-key}","tags":["finance"],"parameters":[{"name":"Zuora-Track-Id","in":"query","required":false,"description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…","schema":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"}},{"name":"Zuora-Entity-Ids","in":"query","required":false,"description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…","schema":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"}},{"name":"subscription-key","in":"query","required":true,"description":"Possible values are: * a subscription number * a subscription ID","schema":{"type":"string","description":"Possible values are: * a subscription number * a subscription ID"}},{"name":"charge-detail","in":"query","required":false,"description":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this…","schema":{"type":"string","description":"The segmented rate plan charges. When an amendment results in a change to a charge, Zuora creates a segmented rate plan charge. Use this…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:zuora/put-subscription":{"post":{"operationId":"finance_zuora_put_subscription","summary":"Update a subscription","description":"PUT /v1/subscriptions/{subscription-key}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You need to set this parameter if you use the following fields: * collect * invoice *…"},"subscription-key":{"type":"string","description":"Subscription number or ID."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-cancel-subscription":{"post":{"operationId":"finance_zuora_put_cancel_subscription","summary":"Cancel a subscription","description":"PUT /v1/subscriptions/{subscription-key}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"subscription-key":{"type":"string","description":"Subscription number or ID. Subscription status must be `Active`."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-renew-subscription":{"post":{"operationId":"finance_zuora_put_renew_subscription","summary":"Renew a subscription","description":"PUT /v1/subscriptions/{subscription-key}/renew","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"subscription-key":{"type":"string","description":"Subscription number or ID"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-resume-subscription":{"post":{"operationId":"finance_zuora_put_resume_subscription","summary":"Resume a subscription","description":"PUT /v1/subscriptions/{subscription-key}/resume","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"subscription-key":{"type":"string","description":"Subscription number or ID. Subscription status must be Suspended."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:zuora/put-suspend-subscription":{"post":{"operationId":"finance_zuora_put_suspend_subscription","summary":"Suspend a subscription","description":"PUT /v1/subscriptions/{subscription-key}/suspend","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscription-key","body"],"properties":{"Zuora-Track-Id":{"type":"string","description":"A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers.…"},"Zuora-Entity-Ids":{"type":"string","description":"An entity ID. If you have [Zuora Multi-entity](https://knowledgecenter.zuora.com/BB_Introducing_Z_Business/Multi-entity) enabled and the…"},"zuora-version":{"type":"string","description":"The minor version of the Zuora REST API. You only need to set this parameter if you use the following fields: * invoice * collect *…"},"subscription-key":{"type":"string","description":"Subscription number or ID. Subscription status must be Active."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}